programmer's documentation
Data Structures | Enumerations | Functions | Variables
cs_parameters.h File Reference
#include <stdarg.h>
#include "cs_defs.h"
#include "cs_field.h"
Include dependency graph for cs_parameters.h:

Go to the source code of this file.

Data Structures

struct  cs_var_cal_opt_t
 
struct  cs_solving_info_t
 
struct  cs_gas_mix_species_prop_t
 
struct  cs_space_disc_t
 
struct  cs_piso_t
 PISO options descriptor. More...
 

Enumerations

enum  cs_parameter_error_behavior_t { CS_WARNING, CS_ABORT_DELAYED, CS_ABORT_IMMEDIATE }
 
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 = 15, CS_CONVECTIVE_INLET = 16
}
 

Functions

cs_piso_tcs_get_glob_piso (void)
 Provide acces to cs_glob_piso. More...
 
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)
 Solved variables are always defined on cells. 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_tcs_parameters_add_boundary_values (cs_field_t *f)
 Define a boundary values field for a variable field. More...
 
cs_field_tcs_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_parameters_error (cs_parameter_error_behavior_t err_behavior, const char *section_desc, const char *format,...)
 Print general parameters error or warning info. More...
 
void cs_parameters_error_header (cs_parameter_error_behavior_t err_behavior, const char *section_desc)
 Print header for a given parameters error message type. More...
 
void cs_parameters_error_footer (cs_parameter_error_behavior_t err_behavior)
 Print footer for a given parameters error message type. More...
 
void cs_parameters_is_in_range_int (cs_parameter_error_behavior_t err_behavior, const char *section_desc, const char *param_name, int param_value, int range_l, int range_u)
 Check that a given integer keyword has values in a specified range. More...
 
void cs_parameters_is_in_list_int (cs_parameter_error_behavior_t err_behavior, const char *section_desc, const char *param_name, int param_value, int enum_size, const int *enum_values, const char *enum_names[])
 Check that a given integer keyword has values in a specified range. More...
 
void cs_parameters_error_barrier (void)
 Abort if the the parameter errors count is nonzero. More...
 

Variables

const cs_space_disc_tcs_glob_space_disc
 
const cs_piso_tcs_glob_piso
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
CS_INDEF 
CS_INLET 
CS_OUTLET 
CS_SYMMETRY 
CS_SMOOTHWALL 
CS_ROUGHWALL 
CS_ESICF 
CS_SSPCF 
CS_SOPCF 
CS_EPHCF 
CS_EQHCF 
CS_COUPLED 
CS_COUPLED_FD 
CS_FREE_INLET 
CS_FREE_SURFACE 
CS_CONVECTIVE_INLET 

◆ cs_parameter_error_behavior_t

Enumerator
CS_WARNING 
CS_ABORT_DELAYED 
CS_ABORT_IMMEDIATE 

Function Documentation

◆ cs_get_glob_piso()

cs_piso_t* cs_get_glob_piso ( void  )

Provide acces to cs_glob_piso.

needed to initialize structure with GUI

Returns
piso information structure

◆ cs_parameters_add_boundary_temperature()

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 variblae does not exist but we have an Enthalpy variables, an associated temperature boundary field is returned.

Returns
pointer to boundary values field, or NULL if not applicable
pointer to boundary values field, or NULL if not applicable

◆ cs_parameters_add_boundary_values()

cs_field_t* cs_parameters_add_boundary_values ( cs_field_t f)

Define a boundary values field for a variable field.

Parameters
[in]fpointer to field structure
Returns
pointer to boundary values field, or NULL if not applicable
Parameters
[in,out]fpointer to field structure
Returns
pointer to boundary values field, or NULL if not applicable

◆ cs_parameters_add_property()

void cs_parameters_add_property ( const char *  name,
int  dim,
int  location_id 
)

Define a user property.

Parameters
[in]namename of property and associated field
[in]dimproperty dimension
[in]location_idid of associated mesh location

◆ cs_parameters_add_variable()

void cs_parameters_add_variable ( const char *  name,
int  dim 
)

Solved variables are always defined on cells.

Define a user variable.

Parameters
[in]namename of variable and associated field
[in]dimvariable dimension

Solved variables are always defined on cells.

Solved variables are always defined on cells.

Parameters
[in]namename of variable and associated field
[in]dimvariable dimension

◆ cs_parameters_add_variable_variance()

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.

Parameters
[in]namename of variance and associated field
[in]variable_namename of associated variable

◆ cs_parameters_create_added_properties()

void cs_parameters_create_added_properties ( void  )

Create previously added user properties.

◆ cs_parameters_create_added_variables()

void cs_parameters_create_added_variables ( void  )

Create previously added user variables.

◆ cs_parameters_define_field_key_gas_mix()

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.

◆ cs_parameters_define_field_keys()

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.

A recommened practice for different submodules would be to use "cs_<module>_key_init() functions to define keys specific to those modules.

◆ cs_parameters_error()

void cs_parameters_error ( cs_parameter_error_behavior_t  err_behavior,
const char *  section_desc,
const char *  format,
  ... 
)

Print general parameters error or warning info.

Parameters
[in]err_behaviorwarn or abort ?
[in]section_descoptional description of code section containing this parameter, or NULL
[in]formatformat string, as printf() and family.
[in]...variable arguments based on format string.

◆ cs_parameters_error_barrier()

void cs_parameters_error_barrier ( void  )

Abort if the the parameter errors count is nonzero.

◆ cs_parameters_error_footer()

void cs_parameters_error_footer ( cs_parameter_error_behavior_t  err_behavior)

Print footer for a given parameters error message type.

Parameters
[in]err_behaviorwarn or abort ?

◆ cs_parameters_error_header()

void cs_parameters_error_header ( cs_parameter_error_behavior_t  err_behavior,
const char *  section_desc 
)

Print header for a given parameters error message type.

Parameters
[in]err_behaviorwarn or abort ?
[in]section_descoptional description of code section containing this parameter, or NULL

◆ cs_parameters_is_in_list_int()

void cs_parameters_is_in_list_int ( cs_parameter_error_behavior_t  err_behavior,
const char *  section_desc,
const char *  param_name,
int  param_value,
int  enum_size,
const int *  enum_values,
const char *  enum_names[] 
)

Check that a given integer keyword has values in a specified range.

Parameters
[in]err_behaviorwarn or abort ?
[in]section_descoptional description of code section containing this parameter, or NULL
[in]param_namename of parameter whose value we are checking
[in]param_valueparameter's current_value
[in]enum_sizesize of possible enumeration
[in]enum_valuesoptional list of enumerated values, or NULL (in which case {0, ... enum_sizes-1} assumed
[in]enum_namesoptional list of value names, or NULL

◆ cs_parameters_is_in_range_int()

void cs_parameters_is_in_range_int ( cs_parameter_error_behavior_t  err_behavior,
const char *  section_desc,
const char *  param_name,
int  param_value,
int  range_l,
int  range_u 
)

Check that a given integer keyword has values in a specified range.

Parameters
[in]err_behaviorwarn or abort ?
[in]section_descoptional description of code section containing this parameter, or NULL
[in]param_namename of parameter whose value we are checking
[in]param_valueparameter's current_value
[in]range_lrange lower bound (included)
[in]range_urange upper bound (excluded)

◆ cs_parameters_n_added_properties()

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.

Returns
number of defined user properties
number of defined user properties

◆ cs_parameters_n_added_variables()

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.

Returns
number of defined user variables

This number is reset to 0 when cs_parameters_create_added_variables is called.

Returns
number of defined user variables

◆ cs_parameters_read_restart_info()

void cs_parameters_read_restart_info ( void  )

Read general restart info.

This updates the previous time step info.

◆ cs_parameters_var_cal_opt_default()

cs_var_cal_opt_t cs_parameters_var_cal_opt_default ( void  )

Return a local variable calculation options structure, with default options.

Returns
variable calculations options structure

Variable Documentation

◆ cs_glob_piso

const cs_piso_t* cs_glob_piso

◆ cs_glob_space_disc

const cs_space_disc_t* cs_glob_space_disc