#include "base/cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include "bft/bft_mem.h"
#include "bft/bft_error.h"
#include "bft/bft_printf.h"
#include "atmo/cs_at_opt_interp.h"
#include "base/cs_ale.h"
#include "base/cs_field.h"
#include "base/cs_field_default.h"
#include "base/cs_field_pointer.h"
#include "alge/cs_gradient.h"
#include "base/cs_log.h"
#include "base/cs_map.h"
#include "mesh/cs_mesh_location.h"
#include "base/cs_post.h"
#include "base/cs_parall.h"
#include "base/cs_parameters_check.h"
#include "base/cs_physical_constants.h"
#include "pprt/cs_physical_model.h"
#include "base/cs_restart.h"
#include "base/cs_restart_default.h"
#include "rayt/cs_rad_transfer_fields.h"
#include "base/cs_syr_coupling.h"
#include "turb/cs_turbulence_model.h"
#include "base/cs_time_moment.h"
#include "base/cs_thermal_model.h"
#include "cfbl/cs_cf_model.h"
#include "base/cs_sat_coupling.h"
#include "base/cs_tree.h"
#include "base/cs_turbomachinery.h"
#include "base/cs_velocity_pressure.h"
#include "base/cs_vof.h"
#include "base/cs_wall_functions.h"
#include "base/cs_parameters.h"

Include dependency graph for cs_parameters.cpp:

Functions
cs_space_disc_t *	cs_get_glob_space_disc (void)
	Provide access to cs_glob_space_disc.
cs_time_scheme_t *	cs_get_glob_time_scheme (void)
	Provide access to cs_glob_time_scheme.
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.
void	cs_parameters_define_field_keys (void)
	Define general field keys.
void	cs_parameters_read_restart_info (void)
	Read general restart info.
void	cs_parameters_add_variable (const char *name, int dim)
	Define a user variable.
void	cs_parameters_add_variable_variance (const char name, const char variable_name)
	Define a user variable which is a variance of another variable.
void	cs_parameters_add_property (const char *name, int dim, int location_id)
	Define a user property.
int	cs_parameters_n_added_variables (void)
	Return the number of defined user variables not added yet.
int	cs_parameters_n_added_properties (void)
	Return the number of defined user properties not added yet.
void	cs_parameters_create_added_variables (void)
	Create previously added user variables.
void	cs_parameters_define_auxiliary_fields (void)
	Create auxiliary fields for some numerical algorithms.
void	cs_parameters_create_added_properties (void)
	Create previously added user properties.
cs_field_t *	cs_parameters_add_boundary_values (cs_field_t *f)
	Define a boundary values field for a variable field.
cs_field_t *	cs_parameters_add_boundary_temperature (void)
	Define a boundary values field for temperature, if applicable.
bool	cs_parameters_need_extended_neighborhood (void)
	Check if extended neighborhood is needed.
void	cs_parameters_global_complete (void)
	Complete global parameters.
void	cs_parameters_eqp_complete (void)
	Complete general equation parameter definitions.
void	cs_parameters_output_complete (void)
	Complete general output option definitions.
cs_equation_param_t	cs_parameters_equation_param_default (void)
	Return a local equation param structure, with default options.
void	cs_time_scheme_log_setup (void)
	Print the time scheme structure to setup.log.
void	cs_space_disc_log_setup (void)
	Print the space discretization structure to setup.log.

Detailed Description

General parameters and options management.

Function Documentation

◆ cs_get_glob_space_disc()

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.

Returns: space discretization description structure

◆ cs_get_glob_time_scheme()

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.

Returns: time scheme 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 variable 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

◆ 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,out] f pointer 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]	name	name of property and associated field
[in]	dim	property dimension
[in]	location_id	id of associated mesh location

◆ cs_parameters_add_variable()

void cs_parameters_add_variable	(	const char *	name,
		int	dim )

Define a user variable.

Solved variables are always defined on cells.

Parameters

[in]	name	name of variable and associated field
[in]	dim	variable 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]	name	name of variance and associated field
[in]	variable_name	name 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_auxiliary_fields()

void cs_parameters_define_auxiliary_fields ( void )

Create auxiliary fields for some numerical algorithms.

Create properties definied directly in C.

◆ 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.

◆ cs_parameters_eqp_complete()

void cs_parameters_eqp_complete ( void )

Complete general equation parameter definitions.

Also set associated field properties such as number of associated time values.

◆ cs_parameters_equation_param_default()

cs_equation_param_t cs_parameters_equation_param_default ( void )

Return a local equation param structure, with default options.

Returns: equation param structure

◆ cs_parameters_global_complete()

void cs_parameters_global_complete ( void )

Complete global parameters.

◆ cs_parameters_n_added_properties()

int cs_parameters_n_added_properties ( void )

Return the number of defined user properties not added yet.

Returns: 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

◆ cs_parameters_need_extended_neighborhood()

bool cs_parameters_need_extended_neighborhood ( void )

Check if extended neighborhood is needed.

Returns: true if extended neighborhoo is needed, false otherwise.

◆ cs_parameters_output_complete()

void cs_parameters_output_complete ( void )

Complete general output option definitions.

Complete general output options definitions.

◆ cs_parameters_read_restart_info()

void cs_parameters_read_restart_info ( void )

Read general restart info.

This updates the previous time step info and notebook varaibles values.

◆ cs_parameters_set_init_state_on()

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.

Parameters

[in] idx id of variable. 1 density.

◆ cs_space_disc_log_setup()

void cs_space_disc_log_setup ( void )

Print the space discretization structure to setup.log.

◆ cs_time_scheme_log_setup()

void cs_time_scheme_log_setup ( void )

Print the time scheme structure to setup.log.

Functions

Detailed Description

Function Documentation

◆ cs_get_glob_space_disc()

◆ cs_get_glob_time_scheme()

◆ cs_parameters_add_boundary_temperature()

◆ cs_parameters_add_boundary_values()

◆ cs_parameters_add_property()

◆ cs_parameters_add_variable()

◆ cs_parameters_add_variable_variance()

◆ cs_parameters_create_added_properties()

◆ cs_parameters_create_added_variables()

◆ cs_parameters_define_auxiliary_fields()

◆ cs_parameters_define_field_keys()

◆ cs_parameters_eqp_complete()

◆ cs_parameters_equation_param_default()

◆ cs_parameters_global_complete()

◆ cs_parameters_n_added_properties()

◆ cs_parameters_n_added_variables()

◆ cs_parameters_need_extended_neighborhood()

◆ cs_parameters_output_complete()

◆ cs_parameters_read_restart_info()

◆ cs_parameters_set_init_state_on()

◆ cs_space_disc_log_setup()

◆ cs_time_scheme_log_setup()