#include "cs_defs.h"
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "bft_mem.h"
#include "bft_error.h"
#include "bft_printf.h"
#include "cs_field.h"
#include "cs_log.h"
#include "cs_map.h"
#include "cs_parall.h"
#include "cs_restart.h"
#include "cs_restart_default.h"
#include "cs_mesh_location.h"
#include "cs_parameters.h"

Include dependency graph for cs_parameters.c:

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

Detailed Description

General parameters and options management.

Function Documentation

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

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

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

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.

Functions

Detailed Description

Function Documentation