1 #ifndef __CS_DOMAIN_H__ 2 #define __CS_DOMAIN_H__ 60 typedef struct _cs_domain_boundary_t cs_domain_boundary_t;
118 cs_groundwater_t *
gw;
247 const char *bdy_name);
323 const char *pty_name,
324 const char *type_name,
340 const char *ref_name);
353 const char *adv_name);
368 const char *ref_name);
447 const char *var_name);
475 double reaction_rate);
505 const char *key_type,
Definition: cs_domain.h:140
int n_properties
Definition: cs_domain.h:89
time step descriptor
Definition: cs_time_step.h:51
cs_time_step_options_t time_options
Definition: cs_domain.h:84
int wall_distance_eq_id
Definition: cs_domain.h:121
cs_time_step_t * time_step
Definition: cs_domain.h:83
void cs_domain_set_param(cs_domain_t *domain, cs_domain_key_t key, const char *keyval)
Set auxiliary parameters related to a cs_domain_t structure.
Definition: cs_domain.c:659
cs_equation_t * cs_domain_get_equation(const cs_domain_t *domain, const char *eqname)
Find the cs_equation_t structure whith name eqname Return NULL if not find.
Definition: cs_domain.c:1319
cs_cdo_connect_t * connect
Definition: cs_domain.h:73
void cs_domain_activate_wall_distance(cs_domain_t *domain)
Activate the computation of the wall distance.
Definition: cs_domain.c:1346
void cs_domain_increment_time(cs_domain_t *domain)
Update time step after one temporal iteration.
Definition: cs_domain.c:1165
cs_domain_t * cs_domain_init(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Create and initialize of cs_domain_t structure.
Definition: cs_domain.c:483
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
void cs_domain_add_boundary(cs_domain_t *domain, const char *ml_name, const char *bdy_name)
Add a boundary type defined on a mesh location.
Definition: cs_domain.c:961
cs_domain_boundary_t * boundaries
Definition: cs_domain.h:77
void cs_domain_add_advection_field(cs_domain_t *domain, const char *adv_name)
Add a new advection field to the current computational domain.
Definition: cs_domain.c:1256
cs_real_t() cs_timestep_func_t(int time_iter, double time)
Simple function to define the time step according to the number of iteration already done...
Definition: cs_cdo.h:171
Definition: cs_cdo_connect.h:67
int n_equations
Definition: cs_domain.h:100
cs_property_t * cs_domain_get_property(const cs_domain_t *domain, const char *ref_name)
Find the related property definition from its name.
Definition: cs_domain.c:1232
int verbosity
Definition: cs_domain.h:128
bool cs_domain_needs_iterate(cs_domain_t *domain)
Check if one needs to continue iterations in time.
Definition: cs_domain.c:1087
void cs_domain_create_fields(cs_domain_t *domain)
Create a cs_field_t structure for each equation defined in the domain.
Definition: cs_domain.c:1770
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
Definition: cs_cdo_quantities.h:100
int output_nt
Definition: cs_domain.h:126
const cs_mesh_t * mesh
Definition: cs_domain.h:65
Definition: cs_domain.h:143
cs_equation_t ** equations
Definition: cs_domain.h:103
void cs_domain_postprocess(cs_domain_t *domain)
Process the computed solution.
Definition: cs_domain.c:1885
void cs_domain_def_time_step_by_function(cs_domain_t *domain, cs_timestep_func_t *func)
Define the value of the time step thanks to a predefined function.
Definition: cs_domain.c:1027
void cs_domain_add_groundwater_tracer(cs_domain_t *domain, const char *eq_name, const char *var_name)
Add a new equation related to the groundwater flow module This equation is a particular type of unste...
Definition: cs_domain.c:1482
void cs_domain_last_setup(cs_domain_t *domain)
Proceed to the last settings of a cs_domain_t structure.
Definition: cs_domain.c:871
const cs_mesh_quantities_t * mesh_quantities
Definition: cs_domain.h:66
int n_predef_equations
Definition: cs_domain.h:101
void cs_domain_set_groundwater_tracer(cs_domain_t *domain, const char *eq_name, const char *ml_name, double wmd, double alpha_l, double alpha_t, double bulk_density, double distrib_coef, double reaction_rate)
Set the parameters related to a tracer equation used in the groundwater flow module.
Definition: cs_domain.c:1551
int n_adv_fields
Definition: cs_domain.h:93
cs_adv_field_t * cs_domain_get_advection_field(const cs_domain_t *domain, const char *ref_name)
Find the related advection field definition from its name.
Definition: cs_domain.c:1292
cs_adv_field_t ** adv_fields
Definition: cs_domain.h:94
Definition: cs_field_pointer.h:64
double dt_cur
Definition: cs_domain.h:80
int n_user_equations
Definition: cs_domain.h:102
Definition: cs_mesh_quantities.h:51
cs_cdo_quantities_t * cdo_quantities
Definition: cs_domain.h:74
void cs_domain_def_time_step_by_value(cs_domain_t *domain, double dt)
Define the value of the time step.
Definition: cs_domain.c:1059
Definition: cs_domain.h:141
Definition: cs_domain.h:137
int richards_eq_id
Definition: cs_domain.h:117
Definition: cs_domain.h:62
void cs_domain_define_current_time_step(cs_domain_t *domain)
Set the current time step for this new time iteration.
Definition: cs_domain.c:1119
bool only_steady
Definition: cs_domain.h:105
Definition: cs_domain.h:144
void cs_domain_setup_predefined_equations(cs_domain_t *domain)
Setup predefined equations which are activated.
Definition: cs_domain.c:1602
Definition: cs_param.h:57
cs_groundwater_t * cs_domain_get_groundwater(const cs_domain_t *domain)
Retrieve the pointer to a cs_groundwater_t structure related to this domain.
Definition: cs_domain.c:1459
void cs_domain_write_restart(const cs_domain_t *domain)
Write a restart file for the CDO module.
Definition: cs_domain.c:1930
bool cs_domain_needs_log(const cs_domain_t *domain)
Check if an ouput is requested according to the domain setting.
Definition: cs_domain.c:726
cs_flag_t scheme_flag
Definition: cs_domain.h:109
void cs_domain_activate_groundwater(cs_domain_t *domain, const char *kw_type, const char *kw_time, int n_soils, int n_tracers)
Activate the computation of the Richards' equation.
Definition: cs_domain.c:1380
time step options descriptor
Definition: cs_time_step.h:76
#define END_C_DECLS
Definition: cs_defs.h:449
cs_domain_t * cs_domain_free(cs_domain_t *domain)
Free a cs_domain_t structure.
Definition: cs_domain.c:601
cs_param_def_type_t time_step_def_type
Definition: cs_domain.h:81
unsigned short int cs_flag_t
Definition: cs_defs.h:298
Definition: cs_domain.h:138
void cs_domain_add_user_equation(cs_domain_t *domain, const char *eqname, const char *varname, const char *key_type, const char *key_bc)
Add a new user equation to a domain.
Definition: cs_domain.c:1712
void cs_domain_solve(cs_domain_t *domain)
Solve all the equations of a computational domain for one time step.
Definition: cs_domain.c:1790
void cs_domain_add_property(cs_domain_t *domain, const char *pty_name, const char *type_name, int n_subdomains)
Add a new property to the current computational domain.
Definition: cs_domain.c:1193
Definition: cs_domain.h:142
cs_real_t output_dt
Definition: cs_domain.h:127
Definition: cs_domain.h:139
cs_domain_key_t
Definition: cs_domain.h:135
bool profiling
Definition: cs_domain.h:129
cs_groundwater_t * gw
Definition: cs_domain.h:118
cs_property_t ** properties
Definition: cs_domain.h:90
cs_param_def_type_t
Definition: cs_param.h:82
cs_def_t time_step_def
Definition: cs_domain.h:82
void cs_domain_summary(const cs_domain_t *domain)
Summary of a cs_domain_t structure.
Definition: cs_domain.c:759