Manage a computational domain. More...
#include "cs_defs.h"#include <assert.h>#include <ctype.h>#include <errno.h>#include <float.h>#include <locale.h>#include <math.h>#include <stdio.h>#include <stdlib.h>#include <string.h>#include <bft_mem.h>#include "cs_boundary_zone.h"#include "cs_coupling.h"#include "cs_log.h"#include "cs_log_iteration.h"#include "cs_math.h"#include "cs_mesh_location.h"#include "cs_property.h"#include "cs_prototypes.h"#include "cs_quadrature.h"#include "cs_restart.h"#include "cs_time_step.h"#include "cs_domain.h"Functions | |
| cs_domain_t * | cs_domain_create (void) |
| Create and initialize by default a cs_domain_t structure. | |
| void | cs_domain_free (cs_domain_t **p_domain) |
| Free a cs_domain_t structure. | |
| void | cs_domain_set_cdo_mode (cs_domain_t *domain, cs_param_cdo_mode_t mode) |
| Set the global variable storing the mode of activation to apply to CDO/HHO schemes. Deprecated way to set the CDO mode. | |
| int | cs_domain_get_cdo_mode (const cs_domain_t *domain) |
| Get the mode of activation for the CDO/HHO schemes. Deprecated way to retrieve the CDO mode. | |
| void | cs_domain_set_output_param (cs_domain_t *domain, int restart_nt, int log_nt, int verbosity) |
| Set parameters related to the way output/logging is done. | |
| void | cs_domain_set_stage (cs_domain_t *domain, cs_domain_stage_t stage) |
| Set the computation stage in the domain structure. | |
| cs_domain_stage_t | cs_domain_get_stage (const cs_domain_t *domain) |
| Retrieve the computation stage from the domain structure. | |
| bool | cs_domain_needs_iteration (cs_domain_t *domain) |
| Check if one needs to continue iterations in time. | |
| bool | cs_domain_needs_log (const cs_domain_t *domain) |
| Check if an output is requested according to the domain setting. | |
| void | cs_domain_increment_time (cs_domain_t *domain) |
| Update the simulated time after one temporal iteration. | |
Variables | |
| cs_domain_t * | cs_glob_domain = nullptr |
| static double | cs_domain_kahan_time_compensation = 0.0 |
Manage a computational domain.
| cs_domain_t * cs_domain_create | ( | void | ) |
Create and initialize by default a cs_domain_t structure.
| void cs_domain_free | ( | cs_domain_t ** | p_domain | ) |
Free a cs_domain_t structure.
| [in,out] | p_domain | pointer of pointer to a cs_domain_t structure |
| int cs_domain_get_cdo_mode | ( | const cs_domain_t * | domain | ) |
Get the mode of activation for the CDO/HHO schemes. Deprecated way to retrieve the CDO mode.
| [in] | domain | pointer to a cs_domain_t structure |
| cs_domain_stage_t cs_domain_get_stage | ( | const cs_domain_t * | domain | ) |
Retrieve the computation stage from the domain structure.
| [in] | domain | pointer to a cs_domain_t structure |
| void cs_domain_increment_time | ( | cs_domain_t * | domain | ) |
Update the simulated time after one temporal iteration.
Update time step after one temporal iteration.
| [in,out] | domain | pointer to a cs_domain_t structure |
| bool cs_domain_needs_iteration | ( | cs_domain_t * | domain | ) |
Check if one needs to continue iterations in time.
| [in,out] | domain | pointer to a cs_domain_t structure |
| bool cs_domain_needs_log | ( | const cs_domain_t * | domain | ) |
Check if an output is requested according to the domain setting.
| [in] | domain | pointer to a cs_domain_t structure |
| void cs_domain_set_cdo_mode | ( | cs_domain_t * | domain, |
| cs_param_cdo_mode_t | mode ) |
Set the global variable storing the mode of activation to apply to CDO/HHO schemes. Deprecated way to set the CDO mode.
| [in,out] | domain | pointer to a cs_domain_t structure |
| [in] | mode | type of activation for the CDO/HHO module |
| void cs_domain_set_output_param | ( | cs_domain_t * | domain, |
| int | restart_nt, | ||
| int | log_nt, | ||
| int | verbosity ) |
Set parameters related to the way output/logging is done.
| [in,out] | domain | pointer to a cs_domain_t structure |
| [in] | restart_nt | frequency for the restart process |
| [in] | log_nt | output frequency into the log (> 0: constant with the given frequency, < 0: automatic with log_nt first iterations detailed, 0: do nothing) |
| [in] | verbosity | level of information displayed |
| void cs_domain_set_stage | ( | cs_domain_t * | domain, |
| cs_domain_stage_t | stage ) |
Set the computation stage in the domain structure.
| [in,out] | domain | pointer to a cs_domain_t structure |
| [in] | stage | stage in the computation run |
|
static |
| cs_domain_t* cs_glob_domain = nullptr |