My Project
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_boundary_conditions.h"
#include "cs_boundary_zone.h"
#include "cs_volume_zone.h"
#include "cs_parameters.h"
#include "cs_prototypes.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_gui_particles.h"
#include "cs_gui_util.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_new.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 "cs_lagr_agglo.h"
#include "cs_lagr_fragmentation.h"
#include "cs_random.h"
Include dependency graph for cs_lagr.c:

Functions

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)
 
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_internal_condition_tcs_lagr_get_internal_conditions (void)
 Return pointer to the main internal conditions structure. More...
 
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...
 
void cs_lagr_finalize_zone_conditions (void)
 Return pointer to the main internal conditions structure. 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)
 

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

cs_lagr_consolidation_model_t* cs_get_lagr_consolidation_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_internal_cond()

void cs_lagr_finalize_internal_cond ( void  )

◆ cs_lagr_finalize_zone_conditions()

void cs_lagr_finalize_zone_conditions ( void  )

Return pointer to the main internal conditions structure.

Finalize the global boundary and volume condition structures.

Returns
pointer to current internal conditions structure

◆ cs_lagr_get_boundary_conditions()

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

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]set_idinjection set id
Returns
pointer to injection set data structure

◆ 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_volume_conditions()

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

◆ 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_injection_set_default()

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

◆ cs_lagr_solve_initialize()

void cs_lagr_solve_initialize ( const cs_real_t dt)

◆ 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