#include <stdarg.h>#include "cs_defs.h"#include "cs_equation_param.h"#include "cs_field.h"#include "cs_tree.h" Include dependency graph for cs_parameters.h:
 Include dependency graph for cs_parameters.h:Go to the source code of this file.
| Data Structures | |
| struct | cs_solving_info_t | 
| struct | cs_space_disc_t | 
| Space discretisation options descriptor.  More... | |
| struct | cs_time_scheme_t | 
| Time scheme descriptor.  More... | |
| struct | cs_restart_auxiliary_t | 
| Additional checkpoint/restart files.  More... | |
| Typedefs | |
| typedef cs_equation_param_t | cs_var_cal_opt_t | 
| Enumerations | |
| enum | { CS_INDEF = 1 , CS_INLET = 2 , CS_OUTLET = 3 , CS_SYMMETRY = 4 , CS_SMOOTHWALL = 5 , CS_ROUGHWALL = 6 , CS_ESICF = 7 , CS_SSPCF = 8 , CS_SOPCF = 9 , CS_EPHCF = 10 , CS_EQHCF = 11 , CS_COUPLED = 12 , CS_COUPLED_FD = 13 , CS_FREE_INLET = 14 , CS_FREE_SURFACE = 64 , CS_CONVECTIVE_INLET = 16 } | 
| enum | { CS_DRIFT_SCALAR_ON = (1 << 0) , CS_DRIFT_SCALAR_ADD_DRIFT_FLUX = (1 << 1) , CS_DRIFT_SCALAR_THERMOPHORESIS = (1 << 2) , CS_DRIFT_SCALAR_TURBOPHORESIS = (1 << 3) , CS_DRIFT_SCALAR_ELECTROPHORESIS = (1 << 4) , CS_DRIFT_SCALAR_CENTRIFUGALFORCE = (1 << 5) , CS_DRIFT_SCALAR_IMPOSED_MASS_FLUX = (1 << 6) , CS_DRIFT_SCALAR_ZERO_BNDY_FLUX = (1 << 7) , CS_DRIFT_SCALAR_ZERO_BNDY_FLUX_AT_WALLS = (1 << 8) , CS_DRIFT_SCALAR_NO_MASS_AGGREGATION = (1 << 9) } | 
| Functions | |
| static int | cs_parameters_iscavr (cs_field_t *f) | 
| For a given field, returns the scalar number of the fluctuating field if given field is a variance.  More... | |
| cs_space_disc_t * | cs_get_glob_space_disc (void) | 
| Provide access to cs_glob_space_disc.  More... | |
| cs_time_scheme_t * | cs_get_glob_time_scheme (void) | 
| Provide access to cs_glob_time_scheme.  More... | |
| void | cs_parameters_set_init_state_on (int idx) | 
| Set init state to 1. This is necessary for fortran mapping and should be changed in the future.  More... | |
| void | cs_parameters_define_field_keys (void) | 
| Define general field keys.  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_define_auxiliary_fields (void) | 
| Create properties definied directly in C.  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... | |
| bool | cs_parameters_need_extended_neighborhood (void) | 
| Check if extended neighborhood is needed.  More... | |
| void | cs_parameters_global_complete (void) | 
| Complete global parameters.  More... | |
| void | cs_parameters_eqp_complete (void) | 
| Complete general equation parameter definitions.  More... | |
| void | cs_parameters_output_complete (void) | 
| Complete general output options definitions.  More... | |
| cs_equation_param_t | cs_parameters_equation_param_default (void) | 
| Return a local equation param structure, with default options.  More... | |
| void | cs_time_scheme_log_setup (void) | 
| Print the time scheme structure to setup.log.  More... | |
| void | cs_space_disc_log_setup (void) | 
| Print the space discretization structure to setup.log.  More... | |
| Variables | |
| const cs_space_disc_t * | cs_glob_space_disc | 
| const cs_time_scheme_t * | cs_glob_time_scheme | 
| cs_restart_auxiliary_t * | cs_glob_restart_auxiliary | 
| cs_tree_node_t * | cs_glob_tree | 
| typedef cs_equation_param_t cs_var_cal_opt_t | 
| anonymous enum | 
| anonymous enum | 
| 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_time_scheme_t* cs_get_glob_time_scheme | ( | void | ) | 
Provide access to cs_glob_time_scheme.
needed to initialize structure with GUI and user C functions.
| cs_field_t* cs_parameters_add_boundary_temperature | ( | void | ) | 
Define a boundary values field for temperature, if applicable.
When a volume temperature variable field already exists, this amounts to calling cs_parameters_add_boundary_values for that field. When such a variable does not exist but we have an Enthalpy variables, an associated temperature boundary field is returned.
| 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.
| [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_auxiliary_fields | ( | void | ) | 
Create properties definied directly in C.
Create properties definied directly in C.
| 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.
| void cs_parameters_eqp_complete | ( | void | ) | 
Complete general equation parameter definitions.
Also set associated field properties such as number of associated time values.
| cs_equation_param_t cs_parameters_equation_param_default | ( | void | ) | 
Return a local equation param structure, with default options.
| void cs_parameters_global_complete | ( | void | ) | 
Complete global parameters.
| 
 | inlinestatic | 
For a given field, returns the scalar number of the fluctuating field if given field is a variance.
| [in] | f | field | 
| int cs_parameters_n_added_properties | ( | void | ) | 
Return the number of defined user properties not added yet.
This number is reset to 0 when cs_parameters_create_added_properties() is called.
| 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.
This number is reset to 0 when cs_parameters_create_added_variables is called.
| bool cs_parameters_need_extended_neighborhood | ( | void | ) | 
Check if extended neighborhood is needed.
| void cs_parameters_output_complete | ( | void | ) | 
Complete general output options definitions.
Complete general output options definitions.
| void cs_parameters_read_restart_info | ( | void | ) | 
Read general restart info.
This updates the previous time step info and notebook varaibles values.
| void cs_parameters_set_init_state_on | ( | int | idx | ) | 
Set init state to 1. This is necessary for fortran mapping and should be changed in the future.
| [in] | idx | id of variable. 0 is viscosity, 1 density, 2 heat capacity. | 
| void cs_space_disc_log_setup | ( | void | ) | 
Print the space discretization structure to setup.log.
| void cs_time_scheme_log_setup | ( | void | ) | 
Print the time scheme structure to setup.log.
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
| 
 | extern | 
Global parameters tree structure