programmer's documentation
Functions
cs_lagr.c File Reference
#include "cs_defs.h"
#include <limits.h>
#include <stdio.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <ctype.h>
#include <float.h>
#include <assert.h>
#include "bft_mem.h"
#include "bft_printf.h"
#include "cs_base.h"
#include "cs_field.h"
#include "cs_field_pointer.h"
#include "cs_math.h"
#include "cs_mesh_location.h"
#include "cs_prototypes.h"
#include "cs_parameters.h"
#include "cs_time_step.h"
#include "cs_physical_constants.h"
#include "cs_thermal_model.h"
#include "cs_turbulence_model.h"
#include "cs_physical_model.h"
#include "cs_parall.h"
#include "cs_post.h"
#include "cs_post_default.h"
#include "cs_lagr.h"
#include "cs_lagr_lec.h"
#include "cs_lagr_geom.h"
#include "cs_lagr_dlvo.h"
#include "cs_lagr_roughness.h"
#include "cs_lagr_clogging.h"
#include "cs_lagr_injection.h"
#include "cs_lagr_gradients.h"
#include "cs_lagr_car.h"
#include "cs_lagr_coupling.h"
#include "cs_lagr_particle.h"
#include "cs_lagr_resuspension.h"
#include "cs_lagr_stat.h"
#include "cs_lagr_tracking.h"
#include "cs_lagr_print.h"
#include "cs_lagr_poisson.h"
#include "cs_lagr_post.h"
#include "cs_lagr_sde.h"
#include "cs_lagr_sde_model.h"
#include "cs_lagr_prototypes.h"
Include dependency graph for cs_lagr.c:

Functions

static cs_lagr_bdy_condition_t_create_bdy_cond_struct (int n_max_zones)
 
static cs_lagr_internal_condition_t_create_internal_cond_struct ()
 
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)
 
void cs_lagr_set_zone_class_temperature (int iclass, int izone, int profile, cs_real_t *temp, cs_real_t emissivity)
 Set temperature parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_cp (int iclass, int izone, cs_real_t cp)
 Set temperature parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_coal (int iclass, int izone, int profile, int number, cs_real_t *temp, cs_real_t *coal_mf, cs_real_t *coke_mf, cs_real_t *coke_density, cs_real_t water_mf, cs_real_t shrink_diam, cs_real_t init_diam)
 Set coal parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_stat (int iclass, int izone, int profile, cs_real_t weight, cs_real_t flow)
 Set coal parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_diam (int iclass, int izone, int profile, cs_real_t diam, cs_real_t diam_dev)
 Set diameter parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_injection (int iclass, int izone, int number, int freq, int stat)
 Set injection parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_velocity (int iclass, int izone, int profile, cs_real_t velocity[])
 Set velocity parameters for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_density (int iclass, int izone, cs_real_t density)
 Set density for a given class of particls and boundary zone. More...
 
void cs_lagr_set_zone_class_foul_index (int iclass, int izone, cs_real_t foul_index)
 Set fouling index for a given class of particles and boundary zone. More...
 
cs_lagr_zone_class_data_tcs_lagr_get_zone_class_data (int iclass, int izone)
 Provide access to class/boundary zone parameters structure. More...
 
cs_lagr_zone_class_data_tcs_lagr_init_zone_class_new (int iclass, int izone)
 Initialize a new class/boundary zone parameters structure. 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_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_internal_condition_tcs_lagr_get_internal_conditions (void)
 Return pointer to the main internal conditions structure. More...
 
cs_lagr_bdy_condition_tcs_lagr_get_bdy_conditions (void)
 Return pointer to the main boundary conditions structure. More...
 
void cs_lagr_finalize_bdy_cond (void)
 
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_time_step (const int itypfb[], const cs_real_t *dt)
 

Function Documentation

§ _create_bdy_cond_struct()

static cs_lagr_bdy_condition_t* _create_bdy_cond_struct ( int  n_max_zones)
static

§ _create_internal_cond_struct()

static cs_lagr_internal_condition_t* _create_internal_cond_struct ( )
static

§ cs_get_lagr_boundary_interactions()

cs_lagr_boundary_interactions_t* cs_get_lagr_boundary_interactions ( void  )

§ cs_get_lagr_brownian()

cs_lagr_brownian_t* cs_get_lagr_brownian ( void  )

§ cs_get_lagr_clogging_model()

cs_lagr_clogging_model_t* cs_get_lagr_clogging_model ( void  )

§ cs_get_lagr_encrustation()

cs_lagr_encrustation_t* cs_get_lagr_encrustation ( void  )

§ cs_get_lagr_extra_module()

cs_lagr_extra_module_t* cs_get_lagr_extra_module ( void  )

§ cs_get_lagr_physico_chemical()

cs_lagr_physico_chemical_t* cs_get_lagr_physico_chemical ( void  )

§ cs_get_lagr_precipitation_model()

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_get_lagr_reentrained_model()

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_get_lagr_source_terms()

cs_lagr_source_terms_t* cs_get_lagr_source_terms ( void  )

§ cs_get_lagr_specific_physics()

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_get_lagr_time_step()

cs_lagr_time_step_t* cs_get_lagr_time_step ( void  )

§ cs_lagr_finalize()

void cs_lagr_finalize ( void  )

§ cs_lagr_finalize_bdy_cond()

void cs_lagr_finalize_bdy_cond ( void  )

§ cs_lagr_finalize_internal_cond()

void cs_lagr_finalize_internal_cond ( void  )

§ cs_lagr_get_bdy_conditions()

cs_lagr_bdy_condition_t* cs_lagr_get_bdy_conditions ( void  )

Return pointer to the main boundary conditions structure.

Returns
pointer to current bdy_contditions or NULL

§ cs_lagr_get_internal_conditions()

cs_lagr_internal_condition_t* cs_lagr_get_internal_conditions ( void  )

Return pointer to the main internal conditions structure.

Returns
pointer to current internal_contditions or NULL

§ cs_lagr_get_particle_counter()

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_get_zone_class_data()

cs_lagr_zone_class_data_t* cs_lagr_get_zone_class_data ( int  iclass,
int  izone 
)

Provide access to class/boundary zone parameters structure.

Parameters
[in]iclassparticle class number
[in]izoneboundary zone number
Returns
pointer to particle class and boundary zone structure of parameters

§ cs_lagr_init_c_arrays()

void cs_lagr_init_c_arrays ( int  dim_cs_glob_lagr_source_terms[2],
cs_real_t **  p_cs_glob_lagr_source_terms 
)

§ cs_lagr_init_zone_class_new()

cs_lagr_zone_class_data_t* cs_lagr_init_zone_class_new ( int  iclass,
int  izone 
)

Initialize a new class/boundary zone parameters structure.

Parameters
[in]iclassparticle class number
[in]izoneboundary zone number
Returns
pointer to particle class and boundary zone structure of parameters

§ cs_lagr_set_zone_class_coal()

void cs_lagr_set_zone_class_coal ( int  iclass,
int  izone,
int  profile,
int  number,
cs_real_t temp,
cs_real_t coal_mf,
cs_real_t coke_mf,
cs_real_t coke_density,
cs_real_t  water_mf,
cs_real_t  shrink_diam,
cs_real_t  init_diam 
)

Set coal parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]profilecoal profile
[in]numbercoal number
[in]temppointer to temperature array
[in]coal_mfpointer to coal mass fraction
[in]coke_mfpointer to coke mass fraction
[in]coke_densitypointer to coke density after pyrolysis
[in]water_mfpointer to water mass fraction
[in]shrink_diampointer to coke shrinking diameter
[in]init_diampointer to initial particle diameter

§ cs_lagr_set_zone_class_cp()

void cs_lagr_set_zone_class_cp ( int  iclass,
int  izone,
cs_real_t  cp 
)

Set temperature parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]cppointer to specific heat value

§ cs_lagr_set_zone_class_density()

void cs_lagr_set_zone_class_density ( int  iclass,
int  izone,
cs_real_t  density 
)

Set density for a given class of particls and boundary zone.

Set density for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]densitypointer to density value

§ cs_lagr_set_zone_class_diam()

void cs_lagr_set_zone_class_diam ( int  iclass,
int  izone,
int  profile,
cs_real_t  diam,
cs_real_t  diam_dev 
)

Set diameter parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]profilepointer to flag for diameter profile
[in]diampointer to diameter value
[in]diam_devpointer to diameter standard deviation value

§ cs_lagr_set_zone_class_foul_index()

void cs_lagr_set_zone_class_foul_index ( int  iclass,
int  izone,
cs_real_t  foul_index 
)

Set fouling index for a given class of particles and boundary zone.

Set density for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]foulingindex pointer to density value

§ cs_lagr_set_zone_class_injection()

void cs_lagr_set_zone_class_injection ( int  iclass,
int  izone,
int  number,
int  freq,
int  stat 
)

Set injection parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]numberpointer to number of particles to inject
[in]freqpointer to injection frequency
[in]statpointer to statistical groups id

§ cs_lagr_set_zone_class_stat()

void cs_lagr_set_zone_class_stat ( int  iclass,
int  izone,
int  profile,
cs_real_t  weight,
cs_real_t  flow 
)

Set coal parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]profilepointer to flag for flow and stat weight profile
[in]weightpointer to stat weight value
[in]flowpointer to mass flow rate value

§ cs_lagr_set_zone_class_temperature()

void cs_lagr_set_zone_class_temperature ( int  iclass,
int  izone,
int  profile,
cs_real_t temp,
cs_real_t  emissivity 
)

Set temperature parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]profiletemperature profile
[in]temppointer to temperature values
[in]emissivityemissivity value

§ cs_lagr_set_zone_class_velocity()

void cs_lagr_set_zone_class_velocity ( int  iclass,
int  izone,
int  profile,
cs_real_t  velocity[] 
)

Set velocity parameters for a given class and boundary zone.

Parameters
[in]iclassclass number
[in]izoneboundary zone number
[in]profilepointer to velocity profile
[in]velocitypointer to velocity values array

§ cs_lagr_solve_time_step()

void cs_lagr_solve_time_step ( const int  itypfb[],
const cs_real_t dt 
)

§ cs_lagr_update_particle_counter()

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