#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:
 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_shape_model_t | 
| struct | cs_lagr_agglomeration_model_t | 
| struct | cs_lagr_fragmentation_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 | 
| 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 { CS_LAGR_BC_UNDEFINED , CS_LAGR_SYM , CS_LAGR_INLET , CS_LAGR_OUTLET , CS_LAGR_REBOUND , CS_LAGR_DEPO1 , CS_LAGR_DEPO2 , CS_LAGR_DEPO_DLVO , CS_LAGR_FOULING , CS_LAGR_BC_USER } | 
| enum | { CS_LAGR_IN_IMPOSED_FLUID_VALUE = -1 , CS_LAGR_IN_IMPOSED_NORM = 0 , CS_LAGR_IN_IMPOSED_COMPONENTS = 1 } | 
| enum | cs_lagr_module_status_t { CS_LAGR_OFF = 0 , CS_LAGR_ONEWAY_COUPLING = 1 , CS_LAGR_TWOWAY_COUPLING = 2 , CS_LAGR_FROZEN_CONTINUOUS_PHASE = 3 } | 
| enum | cs_lagr_module_shape_t { CS_LAGR_SHAPE_SPHERE_MODEL = 0 , CS_LAGR_SHAPE_SPHEROID_STOC_MODEL = 1 , CS_LAGR_SHAPE_SPHEROID_JEFFERY_MODEL = 2 } | 
| enum | { CS_LAGR_PHYS_OFF = 0 , CS_LAGR_PHYS_HEAT = 1 , CS_LAGR_PHYS_COAL = 2 , CS_LAGR_PHYS_CTWR = 3 } | 
| 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);
| [in] | zone_id | id of associated mesh zone | 
| [in] | location_id | id of associated mesh location | 
| [in] | input | pointer to optional (untyped) value or structure. | 
| [in] | n_elts | number of zone elements | 
| [in] | elt_ids | ids of zone elements | 
| [out] | profile | weight of a given zone element (size: n_elts) | 
| anonymous enum | 
| anonymous enum | 
| enum cs_lagr_bc_type | 
Lagrangian boundary condition types
Lagrangian module status. the different values correspond to the following coupling:
| Enumerator | |
|---|---|
| CS_LAGR_OFF | |
| CS_LAGR_ONEWAY_COUPLING | |
| CS_LAGR_TWOWAY_COUPLING | |
| CS_LAGR_FROZEN_CONTINUOUS_PHASE | |
| cs_lagr_agglomeration_model_t* cs_get_lagr_agglomeration_model | ( | void | ) | 
| 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.
| cs_lagr_reentrained_model_t* cs_get_lagr_reentrained_model | ( | void | ) | 
Provide access to cs_lagr_reentrained_model_t.
| cs_lagr_shape_model_t* cs_get_lagr_shape_model | ( | void | ) | 
| 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.
| cs_lagr_time_step_t* cs_get_lagr_time_step | ( | void | ) | 
| void cs_lagr_add_fields | ( | void | ) | 
Create additional fields needed by the Lagrangien model.
Most additional fields can be defined directly in cs_lagr_options_definition, but some fields may be mapped to different fields based on the calling module (i.e. code_saturne or neptune_cfd), and possibly defined after that call.
| 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.
| cs_lagr_zone_data_t* cs_lagr_get_boundary_conditions | ( | void | ) | 
Return pointer to the main boundary conditions 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.
| [in] | zone_data | pointer to boundary or volume conditions structure | 
| [in] | zone_id | zone id | 
| [in] | set_id | injection set id | 
| cs_lagr_internal_condition_t* cs_lagr_get_internal_conditions | ( | void | ) | 
Return pointer to the main internal conditions structure.
The structure is allocated on demand, when this function is first called.
| cs_lagr_particle_counter_t* cs_lagr_get_particle_counter | ( | void | ) | 
Get read/write pointer to global particle counter.
| cs_lagr_zone_data_t* cs_lagr_get_volume_conditions | ( | void | ) | 
Return pointer to the main volume conditions structure.
| void cs_lagr_init_arrays | ( | void | ) | 
| void cs_lagr_injection_set_default | ( | cs_lagr_injection_set_t * | zis | ) | 
Initialize injection set data structure fields to defaults.
| [in,out] | zis | pointer to structure to initialize | 
| void cs_lagr_map_specific_physics | ( | void | ) | 
Map specific phyical model features to Lagrangian structures.
| 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).
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
Fixed constants
| 
 | extern | 
General dimensions
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
Main Lagragian physical model parameters
| 
 | extern | 
Read-only pointer to global particle counter
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
Time and Lagrangian-Eulerian coupling scheme
| 
 | extern | 
| 
 | extern |