1 #ifndef __CS_DOMAIN_H__ 2 #define __CS_DOMAIN_H__ 61 typedef struct _cs_domain_boundary_t cs_domain_boundary_t;
208 const char *ml_name);
308 const char *pty_name,
309 const char *type_name,
325 const char *adv_name);
388 const char *var_name);
414 double reaction_rate);
433 const char *key_type,
472 const char *ref_name);
487 const char *ref_name);
Definition: cs_domain.h:141
int n_properties
Definition: cs_domain.h:90
time step descriptor
Definition: cs_time_step.h:51
cs_time_step_options_t time_options
Definition: cs_domain.h:85
int wall_distance_eq_id
Definition: cs_domain.h:121
Definition: cs_advection_field.h:59
cs_param_boundary_type_t
Definition: cs_param.h:262
cs_time_step_t * time_step
Definition: cs_domain.h:84
cs_domain_t * cs_domain_create(void)
Create and initialize by default a cs_domain_t structure.
Definition: cs_domain.c:381
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:1352
cs_cdo_connect_t * connect
Definition: cs_domain.h:73
void cs_domain_add_boundary(cs_domain_t *domain, cs_param_boundary_type_t type, const char *ml_name)
Add a boundary type defined on a mesh location.
Definition: cs_domain.c:569
void cs_domain_increment_time(cs_domain_t *domain)
Update time step after one temporal iteration.
Definition: cs_domain.c:1706
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
cs_domain_boundary_t * boundaries
Definition: cs_domain.h:77
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:177
Definition: cs_cdo_connect.h:56
cs_equation_t * cs_domain_activate_wall_distance(cs_domain_t *domain)
Activate the computation of the wall distance Define a new equation called "WallDistance" and its rel...
Definition: cs_domain.c:845
void cs_domain_set_default_boundary(cs_domain_t *domain, cs_param_boundary_type_t type)
Add a boundary type defined on a mesh location.
Definition: cs_domain.c:544
int n_equations
Definition: cs_domain.h:101
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:1299
int verbosity
Definition: cs_domain.h:127
bool cs_domain_needs_iterate(cs_domain_t *domain)
Check if one needs to continue iterations in time.
Definition: cs_domain.c:1586
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:1400
void cs_domain_set_advanced_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:671
void cs_domain_set_output_param(cs_domain_t *domain, int nt_list, int verbosity)
Set auxiliary parameters related to the way output is done.
Definition: cs_domain.c:631
void cs_domain_process_after_solve(cs_domain_t *domain)
Process the computational domain after the resolution.
Definition: cs_domain.c:1821
void cs_domain_set_scheme_flag(cs_domain_t *domain)
Define the scheme flag for the current computational domain.
Definition: cs_domain.c:1420
Definition: cs_cdo_quantities.h:102
int output_nt
Definition: cs_domain.h:126
const cs_mesh_t * mesh
Definition: cs_domain.h:66
cs_equation_t ** equations
Definition: cs_domain.h:104
cs_timer_counter_t tcs
Definition: cs_domain.h:134
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:703
void cs_domain_update_mesh_locations(cs_domain_t *domain)
Add new mesh locations related to domain boundaries from existing mesh locations. ...
Definition: cs_domain.c:1074
const cs_mesh_quantities_t * mesh_quantities
Definition: cs_domain.h:67
int n_predef_equations
Definition: cs_domain.h:102
cs_domain_t * cs_glob_domain
Definition: cs_domain.c:83
int n_adv_fields
Definition: cs_domain.h:94
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:1325
cs_adv_field_t ** adv_fields
Definition: cs_domain.h:95
Definition: cs_field_pointer.h:65
bool is_last_iter
Definition: cs_domain.h:80
double dt_cur
Definition: cs_domain.h:81
int n_user_equations
Definition: cs_domain.h:103
Definition: cs_mesh_quantities.h:52
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:734
void cs_domain_update_advfield(cs_domain_t *domain)
Set to true the automatic update of all advection fields.
Definition: cs_domain.c:653
bool force_advfield_update
Definition: cs_domain.h:107
int richards_eq_id
Definition: cs_domain.h:117
Definition: cs_domain.h:63
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:1649
cs_adv_field_t * 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:805
bool only_steady
Definition: cs_domain.h:106
cs_gwf_t * gwf
Definition: cs_domain.h:118
Definition: cs_domain.h:142
void cs_domain_add_gwf_tracer_eq(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:965
cs_gwf_t * cs_domain_activate_gwf(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 This activation yields severals consequences: ...
Definition: cs_domain.c:889
void cs_domain_setup_predefined_equations(cs_domain_t *domain)
Setup predefined equations which are activated.
Definition: cs_domain.c:1130
cs_timer_counter_t tcp
Definition: cs_domain.h:132
Definition: cs_param.h:72
void cs_domain_set_gwf_tracer_eq(cs_domain_t *domain, const char *eq_name, const char *ml_name, double wmd, double alpha_l, double alpha_t, double distrib_coef, double reaction_rate)
Set the parameters related to a tracer equation used in the groundwater flow module.
Definition: cs_domain.c:1027
void cs_domain_write_restart(const cs_domain_t *domain)
Write a restart file for the CDO module.
Definition: cs_domain.c:1862
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:1620
cs_flag_t scheme_flag
Definition: cs_domain.h:111
time step options descriptor
Definition: cs_time_step.h:76
#define END_C_DECLS
Definition: cs_defs.h:452
cs_domain_t * cs_domain_free(cs_domain_t *domain)
Free a cs_domain_t structure.
Definition: cs_domain.c:476
cs_param_def_type_t time_step_def_type
Definition: cs_domain.h:82
unsigned short int cs_flag_t
Definition: cs_defs.h:299
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:1240
cs_property_t * 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:764
void cs_domain_solve(cs_domain_t *domain)
Solve all the equations of a computational domain for one time step.
Definition: cs_domain.c:1731
void cs_domain_initialize(cs_domain_t *domain, cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Build a cs_domain_t structure.
Definition: cs_domain.c:1478
cs_gwf_t * cs_domain_get_gwf_struct(const cs_domain_t *domain)
Retrieve the pointer to a cs_gwf_t structure related to this domain.
Definition: cs_domain.c:1382
cs_domain_key_t
Definition: cs_domain.h:139
bool profiling
Definition: cs_domain.h:128
void cs_domain_set_time_param(cs_domain_t *domain, int nt_max, double t_max)
Set parameters for unsteady computations: the max number of time steps or the final physical time of ...
Definition: cs_domain.c:610
cs_property_t ** properties
Definition: cs_domain.h:91
Definition: cs_property.h:66
cs_param_def_type_t
Definition: cs_param.h:94
cs_def_t time_step_def
Definition: cs_domain.h:83
void cs_domain_summary(const cs_domain_t *domain)
Summary of a cs_domain_t structure.
Definition: cs_domain.c:1950
Definition: cs_timer.h:57