programmer's documentation
Data Structures | Enumerations | Functions | Variables
cs_parameters.h File Reference
#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
 Space discretisation options descriptor. More...
 
struct  cs_piso_t
 PISO options descriptor. More...
 

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_FREE_INLET = 13, CS_FREE_SURFACE = 14, CS_CONVECTIVE_INLET = 15
}
 

Functions

cs_piso_tcs_get_glob_piso (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_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...
 

Variables

const cs_space_disc_tcs_glob_space_disc
 
const cs_piso_tcs_glob_piso
 

Enumeration Type Documentation

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_FREE_INLET 
CS_FREE_SURFACE 
CS_CONVECTIVE_INLET 

Function Documentation

cs_piso_t* cs_get_glob_piso ( void  )
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_field_t* cs_parameters_add_boundary_values ( cs_field_t f)

Define a boundary values field for a variable field.

Parameters
[in,out]fpointer to field structure
Returns
pointer to boundary values field, or NULL if not applicable
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
void cs_parameters_add_variable ( const char *  name,
int  dim 
)

Define a user variable.

Solved variables are always defined on cells.

Parameters
[in]namename of variable and associated field
[in]dimvariable 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.

Parameters
[in]namename of variance and associated field
[in]variable_namename 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 recommened practice for different submodules would be to use "cs_<module>_key_init() functions to define keys specific to those modules.

int cs_parameters_n_added_properties ( void  )

Return the number of defined user properties not added yet.

Returns
number of defined user properties
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
void cs_parameters_read_restart_info ( void  )

Read general restart info.

This updates the previous time step info.

Variable Documentation

const cs_piso_t* cs_glob_piso
const cs_space_disc_t* cs_glob_space_disc