programmer's documentation
Data Structures | Enumerations | Functions | Variables
cs_lagr.h File Reference
#include "cs_defs.h"
#include "assert.h"
#include "cs_base.h"
#include "cs_field.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_time_step_t
 
struct  cs_lagr_zone_class_data_t
 
struct  cs_lagr_source_terms_t
 
struct  cs_lagr_bdy_condition_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_visualization_t
 
struct  cs_lagr_extra_module_t
 
struct  cs_lagr_coal_comb_t
 

Enumerations

enum  cs_lagr_bc_type_t {
  CS_LAGR_INLET = 1, CS_LAGR_OUTLET = 2, CS_LAGR_REBOUND = 3, CS_LAGR_DEPO1 = 4,
  CS_LAGR_DEPO2 = 5, CS_LAGR_FOULING = 7, CS_LAGR_JBORD1 = 8, CS_LAGR_JBORD2 = 9,
  CS_LAGR_JBORD3 = 10, CS_LAGR_JBORD4 = 11, CS_LAGR_JBORD5 = 12, CS_LAGR_DEPO_DLVO = 13,
  CS_LAGR_SYM = 14
}
 
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_NO_MOTION = 10,
  CS_LAGR_PART_IMPOSED_MOTION = 11
}
 

Functions

cs_lagr_zone_class_data_tcs_lagr_get_zone_class_data (int iclass, int izone)
 Provide access to class/boundary zone parameters structure. 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_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_density (int iclass, int izone, cs_real_t density)
 Set density for a given class and boundary zone. More...
 
void cs_lagr_set_zone_class_foul_index (int iclass, int izone, cs_real_t foul_index)
 Set density 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...
 
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_visualization_tcs_get_lagr_visualization (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)
 
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
 
int cs_glob_lagr_nzone_max
 
int cs_glob_lagr_nclass_max
 
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_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
 
cs_lagr_bdy_condition_tcs_glob_lagr_bdy_conditions
 
cs_lagr_internal_condition_tcs_glob_lagr_internal_conditions
 
cs_lagr_zone_class_data_tlagr_zone_class_data
 
cs_real_4_tcs_glob_lagr_b_u_normal
 
cs_real_33_tcs_glob_lagr_b_face_proj
 

Enumeration Type Documentation

§ cs_lagr_bc_type_t

Lagrangian boundary condition types

Enumerator
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 

§ cs_lagr_deposition_state_t

Lagrangian deposition state

Enumerator
CS_LAGR_PART_IN_FLOW 
CS_LAGR_PART_DEPOSITED 
CS_LAGR_PART_ROLLING 
CS_LAGR_PART_NO_MOTION 
CS_LAGR_PART_IMPOSED_MOTION 

Function Documentation

§ 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_get_lagr_visualization()

cs_lagr_visualization_t* cs_get_lagr_visualization ( 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_conditions or NULL
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 and boundary zone.

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

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 density for a given class and boundary zone.

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

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

Variable Documentation

§ bound_stat

cs_real_t* bound_stat

§ cs_glob_lagr_b_face_proj

cs_real_33_t* cs_glob_lagr_b_face_proj

§ cs_glob_lagr_b_u_normal

cs_real_4_t* cs_glob_lagr_b_u_normal

§ cs_glob_lagr_bdy_conditions

cs_lagr_bdy_condition_t* cs_glob_lagr_bdy_conditions

§ cs_glob_lagr_boundary_interactions

cs_lagr_boundary_interactions_t* cs_glob_lagr_boundary_interactions

§ cs_glob_lagr_brownian

cs_lagr_brownian_t* cs_glob_lagr_brownian

§ cs_glob_lagr_clogging_model

cs_lagr_clogging_model_t* cs_glob_lagr_clogging_model

§ cs_glob_lagr_coal_comb

cs_lagr_coal_comb_t* cs_glob_lagr_coal_comb

§ cs_glob_lagr_const_dim

const cs_lagr_const_dim_t* cs_glob_lagr_const_dim

Fixed constants

§ cs_glob_lagr_dim

cs_lagr_dim_t* cs_glob_lagr_dim

General dimensions

§ cs_glob_lagr_encrustation

cs_lagr_encrustation_t* cs_glob_lagr_encrustation

§ cs_glob_lagr_extra_module

cs_lagr_extra_module_t* cs_glob_lagr_extra_module

§ cs_glob_lagr_internal_conditions

cs_lagr_internal_condition_t* cs_glob_lagr_internal_conditions

§ cs_glob_lagr_log_frequency_n

int cs_glob_lagr_log_frequency_n

§ cs_glob_lagr_model

cs_lagr_model_t* cs_glob_lagr_model

Main Lagragian physical model parameters

§ cs_glob_lagr_nclass_max

int cs_glob_lagr_nclass_max

§ cs_glob_lagr_nzone_max

int cs_glob_lagr_nzone_max

§ cs_glob_lagr_particle_counter

const cs_lagr_particle_counter_t* cs_glob_lagr_particle_counter

Read-only pointer to global particle counter

§ cs_glob_lagr_physico_chemical

cs_lagr_physico_chemical_t* cs_glob_lagr_physico_chemical

§ cs_glob_lagr_precipitation_model

cs_lagr_precipitation_model_t* cs_glob_lagr_precipitation_model

§ cs_glob_lagr_reentrained_model

cs_lagr_reentrained_model_t* cs_glob_lagr_reentrained_model

§ cs_glob_lagr_source_terms

cs_lagr_source_terms_t* cs_glob_lagr_source_terms

§ cs_glob_lagr_specific_physics

cs_lagr_specific_physics_t* cs_glob_lagr_specific_physics

§ cs_glob_lagr_time_scheme

cs_lagr_time_scheme_t* cs_glob_lagr_time_scheme

Time and Lagrangian-Eulerian coupling scheme

§ cs_glob_lagr_time_step

cs_lagr_time_step_t* cs_glob_lagr_time_step

§ lagr_zone_class_data

cs_lagr_zone_class_data_t* lagr_zone_class_data