 |
programmer's documentation
|
|
programmer's documentation
|
#include "cs_defs.h"#include <assert.h>#include <stdio.h>#include <stdarg.h>#include <stdlib.h>#include <string.h>#include "bft_mem.h"#include "bft_error.h"#include "bft_printf.h"#include "cs_convection_diffusion.h"#include "cs_field.h"#include "cs_log.h"#include "cs_map.h"#include "cs_post.h"#include "cs_parall.h"#include "cs_restart.h"#include "cs_restart_default.h"#include "cs_mesh_location.h"#include "cs_tree.h"#include "cs_parameters.h"
Functions | |
| cs_space_disc_t * | cs_get_glob_space_disc (void) |
| Provide access to cs_glob_space_disc. More... | |
| cs_piso_t * | cs_get_glob_piso (void) |
| Provide acces to cs_glob_piso. More... | |
| void | cs_parameters_set_n_buoyant_scalars (void) |
| void | cs_parameters_define_field_keys (void) |
| Define general field keys. More... | |
| void | cs_parameters_define_field_key_gas_mix (void) |
| Define field key for condensation. More... | |
| void | cs_parameters_read_restart_info (void) |
| Read general restart info. More... | |
| void | cs_parameters_add_variable (const char *name, int dim) |
| Define a user variable. More... | |
| void | cs_parameters_add_variable_variance (const char *name, const char *variable_name) |
| Define a user variable which is a variance of another variable. More... | |
| void | cs_parameters_add_property (const char *name, int dim, int location_id) |
| Define a user property. More... | |
| int | cs_parameters_n_added_variables (void) |
| Return the number of defined user variables not added yet. More... | |
| int | cs_parameters_n_added_properties (void) |
| Return the number of defined user properties not added yet. More... | |
| void | cs_parameters_create_added_variables (void) |
| Create previously added user variables. More... | |
| void | cs_parameters_create_added_properties (void) |
| Create previously added user properties. More... | |
| cs_field_t * | cs_parameters_add_boundary_values (cs_field_t *f) |
| Define a boundary values field for a variable field. More... | |
| cs_field_t * | cs_parameters_add_boundary_temperature (void) |
| Define a boundary values field for temperature, if applicable. More... | |
| cs_var_cal_opt_t | cs_parameters_var_cal_opt_default (void) |
| Return a local variable calculation options structure, with default options. More... | |
| void | cs_space_disc_log_setup (void) |
| Print the space discretization structure to setup.log. More... | |
General parameters and options management.
| cs_piso_t* cs_get_glob_piso | ( | void | ) |
Provide acces to cs_glob_piso.
needed to initialize structure with GUI and user C functions.
| cs_space_disc_t* cs_get_glob_space_disc | ( | void | ) |
Provide access to cs_glob_space_disc.
needed to initialize structure in GUI and user C functions.
| cs_field_t* cs_parameters_add_boundary_temperature | ( | void | ) |
Define a boundary values field for temperature, if applicable.
| cs_field_t* cs_parameters_add_boundary_values | ( | cs_field_t * | f | ) |
Define a boundary values field for a variable field.
| [in,out] | f | pointer to field structure |
| void cs_parameters_add_property | ( | const char * | name, |
| int | dim, | ||
| int | location_id | ||
| ) |
Define a user property.
| [in] | name | name of property and associated field |
| [in] | dim | property dimension |
| [in] | location_id | id of associated mesh location |
| void cs_parameters_add_variable | ( | const char * | name, |
| int | dim | ||
| ) |
Define a user variable.
Solved variables are always defined on cells.
Solved variables are always defined on cells.
| [in] | name | name of variable and associated field |
| [in] | dim | variable dimension |
| void cs_parameters_add_variable_variance | ( | const char * | name, |
| const char * | variable_name | ||
| ) |
Define a user variable which is a variance of another variable.
Only variances of thermal or user-defined variables are currently handled.
| [in] | name | name of variance and associated field |
| [in] | variable_name | name of associated variable |
| void cs_parameters_create_added_properties | ( | void | ) |
Create previously added user properties.
| void cs_parameters_create_added_variables | ( | void | ) |
Create previously added user variables.
| void cs_parameters_define_field_key_gas_mix | ( | void | ) |
Define field key for condensation.
Note: this should be moved in the future to a condensation-specific file.
| void cs_parameters_define_field_keys | ( | void | ) |
Define general field keys.
A recommended practice for different submodules would be to use "cs_<module>_key_init() functions to define keys specific to those modules.
Is the field time-extrapolated? -1: default automatic value 0: "standard" first-order: the value calculated at the beginning of the current time step (from the variables known at the end of the previous time step) is used 1: second-order: the physical property 
is extrapolated according to the formula ![$\phi^{n+\theta}=[(1+\theta)\phi^n-\theta \phi^{n-1}]$](form_180.png)
, 
being given by the value of 0.5 2: first-order: the physical property is extrapolated at $n+1$ according to the same formula as when = 1 but with = 1
| int cs_parameters_n_added_properties | ( | void | ) |
Return the number of defined user properties not added yet.
| int cs_parameters_n_added_variables | ( | void | ) |
Return the number of defined user variables not added yet.
This number is reset to 0 when cs_parameters_create_added_variables is called.
| void cs_parameters_read_restart_info | ( | void | ) |
Read general restart info.
This updates the previous time step info.
| void cs_parameters_set_n_buoyant_scalars | ( | void | ) |
| cs_var_cal_opt_t cs_parameters_var_cal_opt_default | ( | void | ) |
Return a local variable calculation options structure, with default options.
| void cs_space_disc_log_setup | ( | void | ) |
Print the space discretization structure to setup.log.
1.8.13