![]() |
programmer's documentation
|
Go to the source code of this file.
Macros | |
#define | CS_GROUNDWATER_POST_MOISTURE (1 << 0) |
Enumerations | |
enum | cs_groundwater_model_t { CS_GROUNDWATER_MODEL_SATURATED, CS_GROUNDWATER_MODEL_GENUCHTEN, CS_GROUNDWATER_MODEL_TRACY, CS_GROUNDWATER_MODEL_USER, CS_GROUNDWATER_N_MODELS } |
Functions | |
cs_groundwater_t * | cs_groundwater_create (void) |
Create a structure dedicated to manage groundwater flows. More... | |
cs_groundwater_t * | cs_groundwater_finalize (cs_groundwater_t *gw) |
Free the main structure related to groundwater flows. More... | |
void | cs_groundwater_set_param (cs_groundwater_t *gw, const char *keyname, const char *keyval) |
Set parameters related to a cs_groundwater_t structure. More... | |
void | cs_groundwater_summary (const cs_groundwater_t *gw) |
Summary of a cs_groundwater_t structure. More... | |
cs_equation_t * | cs_groundwater_init (const cs_cdo_connect_t *connect, int richards_eq_id, const char *model, cs_property_t *permeability, cs_property_t *soil_capacity, cs_adv_field_t *adv_field, cs_groundwater_t *gw) |
Initialize the module dedicated to groundwater flows. More... | |
cs_equation_t * | cs_groundwater_add_tracer (cs_groundwater_t *gv, int tracer_eq_id, const char *eq_name, const char *var_name, cs_property_t *diff_property, cs_real_3_t dispersivity, double bulk_density, double distrib_coef, double reaction_rate) |
Add a new equation related to the groundwater flow module This equation is a specific unsteady advection/diffusion/reaction eq. Tracer is advected thanks to the darcian velocity which is given by the resolution of the Richards equation. Diffusion/reaction parameters result from a physical modelling. More... | |
void | cs_groundwater_automatic_settings (cs_equation_t **equations, cs_groundwater_t *gw) |
Predefined settings for the module dedicated to groundwater flows. More... | |
void | cs_groundwater_compute (const cs_mesh_t *mesh, const cs_time_step_t *time_step, double dt_cur, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *cdoq, cs_equation_t *eqs[], cs_groundwater_t *gw) |
Compute the system related to groundwater flows. More... | |
void | cs_groundwater_post (const cs_time_step_t *time_step, const cs_groundwater_t *gw) |
Predefined postprocessing for the groundwater module. More... | |
#define CS_GROUNDWATER_POST_MOISTURE (1 << 0) |
cs_equation_t* cs_groundwater_add_tracer | ( | cs_groundwater_t * | gw, |
int | tracer_eq_id, | ||
const char * | eqname, | ||
const char * | varname, | ||
cs_property_t * | diff_property, | ||
cs_real_3_t | dispersivity, | ||
double | bulk_density, | ||
double | distrib_coef, | ||
double | reaction_rate | ||
) |
Add a new equation related to the groundwater flow module This equation is a specific unsteady advection/diffusion/reaction eq. Tracer is advected thanks to the darcian velocity which is given by the resolution of the Richards equation. Diffusion/reaction parameters result from a physical modelling.
[in,out] | gw | pointer to a cs_groundwater_t structure |
[in] | tracer_eq_id | id related to the tracer equation |
[in] | eqname | name of the equation |
[in] | varname | name of the related variable |
[in] | diff_property | pointer to a cs_property_t struct. |
[in] | dispersivity | dispersivity for each axis (x, y, z] |
[in] | bulk_density | value of the bulk density |
[in] | distrib_coef | value of the distribution coefficient |
[in] | reaction_rate | value of the first order rate of reaction |
void cs_groundwater_automatic_settings | ( | cs_equation_t ** | equations, |
cs_groundwater_t * | gw | ||
) |
Predefined settings for the module dedicated to groundwater flows.
[in,out] | equations | pointer to the array of cs_equation_t struct. |
[in,out] | gw | pointer to a cs_groundwater_t structure |
void cs_groundwater_compute | ( | const cs_mesh_t * | mesh, |
const cs_time_step_t * | time_step, | ||
double | dt_cur, | ||
const cs_cdo_connect_t * | connect, | ||
const cs_cdo_quantities_t * | cdoq, | ||
cs_equation_t * | eqs[], | ||
cs_groundwater_t * | gw | ||
) |
Compute the system related to groundwater flows.
[in] | mesh | pointer to a cs_mesh_t structure |
[in] | time_step | pointer to a cs_time_step_t structure |
[in] | dt_cur | current value of the time step |
[in] | connect | pointer to a cs_cdo_connect_t structure |
[in] | cdoq | pointer to a cs_cdo_quantities_t structure |
[in,out] | eqs | array of pointers to cs_equation_t structures |
[in,out] | gw | pointer to a cs_groundwater_t structure |
cs_groundwater_t* cs_groundwater_create | ( | void | ) |
Create a structure dedicated to manage groundwater flows.
cs_groundwater_t* cs_groundwater_finalize | ( | cs_groundwater_t * | gw | ) |
Free the main structure related to groundwater flows.
[in,out] | gw | pointer to a cs_groundwater_t struct. to free |
cs_equation_t* cs_groundwater_init | ( | const cs_cdo_connect_t * | connect, |
int | richards_eq_id, | ||
const char * | model, | ||
cs_property_t * | permeability, | ||
cs_property_t * | soil_capacity, | ||
cs_adv_field_t * | adv_field, | ||
cs_groundwater_t * | gw | ||
) |
Initialize the module dedicated to groundwater flows.
[in] | connect | pointer to a cs_cdo_connect_t structure |
[in] | richards_eq_id | id related to the Richards equation |
[in] | model | keyword related to the model used |
[in,out] | permeability | pointer to a property structure |
[in,out] | soil_capacity | pointer to a property structure |
[in,out] | adv_field | pointer to a cs_adv_field_t structure |
[in,out] | gw | pointer to a cs_groundwater_t structure |
void cs_groundwater_post | ( | const cs_time_step_t * | time_step, |
const cs_groundwater_t * | gw | ||
) |
Predefined postprocessing for the groundwater module.
[in] | time_step | pointer to a cs_time_step_t struct. |
[in] | gw | pointer to a cs_groundwater_t structure |
void cs_groundwater_set_param | ( | cs_groundwater_t * | gw, |
const char * | keyname, | ||
const char * | keyval | ||
) |
Set parameters related to a cs_groundwater_t structure.
[in,out] | gw | pointer to a cs_groundwater_t structure |
[in] | keyname | name of key related to the member of adv to set |
[in] | keyval | accessor to the value to set |
void cs_groundwater_summary | ( | const cs_groundwater_t * | gw | ) |
Summary of a cs_groundwater_t structure.
[in] | gw | pointer to a cs_groundwater_t struct. to summarize |