cs_domain_setup.h File Reference

#include "cs_defs.h"
#include "cs_domain.h"
#include "cs_param_types.h"

Include dependency graph for cs_domain_setup.h:

Go to the source code of this file.

Functions
void	cs_f_domain_setup_init_model_context (void)
	When the models have been activated, continue to allocate, add and define structures related to those models This function is called after the user function cs_user_model and before the user function cs_user_parameters. More...
void	cs_f_domain_initialize_cdo_systems (void)
	Initialize CDO systems. More...
void	cs_domain_set_output_param (cs_domain_t *domain, int nt_interval, int nt_list, int verbosity)
	Set to true the automatic update of all advection fields. More...
void	cs_domain_set_time_param (cs_domain_t *domain, int nt_max, double t_max)
	Set parameters for unsteady computations: the max number of time steps or the final physical time of the simulation. More...
void	cs_domain_automatic_time_step_settings (cs_domain_t *domain)
	Set time step parameters for unsteady computations when this is not already done. This situation should occur when the GUI is used to set a constant time step. More...
cs_xdef_t *	cs_domain_def_time_step_by_function (cs_domain_t *domain, cs_time_func_t *func, void *func_input)
	Define the value of the time step thanks to a predefined function. More...
void	cs_domain_def_time_step_by_value (cs_domain_t *domain, double dt)
	Define the value of the time step. More...
void	cs_domain_initialize_setup (cs_domain_t *domain)
	First setup stage of the cs_domain_t structure Define extra domain boundaries Setup predefined equations Create fields (already done in the FV part) Define cs_sles_t structures for variable fields. More...
void	cs_domain_init_cdo_structures (cs_domain_t *domain)
	After having read the mesh and the first setup stage build the connectivities and mesh quantities related to CDO/HHO schemes. More...
void	cs_domain_finalize_user_setup (cs_domain_t *domain)
	Last user setup stage of the cs_domain_t structure. More...
void	cs_domain_finalize_module_setup (cs_domain_t *domain)
	Last setup stage of the cs_domain_t structure. More...
void	cs_domain_initialize_systems (cs_domain_t *domain)
	Initialize systems of equations and their related field values according to the user settings. More...
void	cs_domain_setup_log (const cs_domain_t *domain)
	Summary of the main domain settings. More...

Function Documentation

cs_domain_automatic_time_step_settings()

void cs_domain_automatic_time_step_settings

(

cs_domain_t *

domain

)

Set time step parameters for unsteady computations when this is not already done. This situation should occur when the GUI is used to set a constant time step.

Parameters

[in,out]

domain

pointer to a cs_domain_t structure

cs_domain_def_time_step_by_function()

cs_xdef_t* cs_domain_def_time_step_by_function	(	cs_domain_t *	domain,
		cs_time_func_t *	func,
		void *	func_input
	)

Define the value of the time step thanks to a predefined function.

Parameters

[in,out]	domain	pointer to a cs_domain_t structure
[in]	func	pointer to a cs_time_func_t function
[in]	func_input	pointer to a structure cast on-the-fly

Returns

a pointer to the created definition (cs_xdef_t structure)

cs_domain_def_time_step_by_value()

void cs_domain_def_time_step_by_value	(	cs_domain_t *	domain,
		double	dt
	)

Define the value of the time step.

Parameters

[in,out]	domain	pointer to a cs_domain_t structure
[in]	dt	value of the constant time step

cs_domain_finalize_module_setup()

void cs_domain_finalize_module_setup

(

cs_domain_t *

domain

)

Last setup stage of the cs_domain_t structure.

Parameters

[in,out]

domain

pointer to a cs_domain_t struct.

Last setup stage of the cs_domain_t structure.

Parameters

[in,out]

domain

pointer to a cs_domain_t struct.

cs_domain_finalize_user_setup()

void cs_domain_finalize_user_setup

(

cs_domain_t *

domain

)

Last user setup stage of the cs_domain_t structure.

Parameters

[in,out]

domain

pointer to a cs_domain_t struct.

cs_domain_init_cdo_structures()

void cs_domain_init_cdo_structures

(

cs_domain_t *

domain

)

After having read the mesh and the first setup stage build the connectivities and mesh quantities related to CDO/HHO schemes.

Parameters

[in,out]

domain

pointer to a cs_domain_t struct.

cs_domain_initialize_setup()

void cs_domain_initialize_setup

(

cs_domain_t *

domain

)

First setup stage of the cs_domain_t structure Define extra domain boundaries Setup predefined equations Create fields (already done in the FV part) Define cs_sles_t structures for variable fields.

Parameters

[in,out]

domain

pointer to a cs_domain_t struct.

cs_domain_initialize_systems()

void cs_domain_initialize_systems

(

cs_domain_t *

domain

)

Initialize systems of equations and their related field values according to the user settings.

Parameters

[in,out]

domain

pointer to a cs_domain_t structure

cs_domain_set_output_param()

void cs_domain_set_output_param	(	cs_domain_t *	domain,
		int	nt_interval,
		int	nt_list,
		int	verbosity
	)

Set to true the automatic update of all advection fields.

Set auxiliary parameters related to the way output is done

Parameters

[in,out]	domain	pointer to a cs_domain_t structure
[in]	nt_interval	frequency for the restart process
[in]	nt_list	output frequency into the log
[in]	verbosity	level of information displayed

Set to true the automatic update of all advection fields.

Parameters

[in,out]	domain	pointer to a cs_domain_t structure
[in]	nt_interval	frequency for the restart process
[in]	nt_list	output frequency into the log
[in]	verbosity	level of information displayed

cs_domain_set_time_param()

void cs_domain_set_time_param	(	cs_domain_t *	domain,
		int	nt_max,
		double	t_max
	)

Set parameters for unsteady computations: the max number of time steps or the final physical time of the simulation.

Parameters

[in,out]	domain	pointer to a cs_domain_t structure
[in]	nt_max	max. number of time step iterations
[in]	t_max	final physical time of the simulation
[in,out]	domain	pointer to a cs_domain_t structure
[in]	nt_max	max. number of time step iterations
[in]	t_max	final physical time of the simulation

cs_domain_setup_log()

void cs_domain_setup_log

(

const cs_domain_t *

domain

)

Summary of the main domain settings.

Parameters

[in]

domain

pointer to the cs_domain_t structure to summarize

cs_f_domain_initialize_cdo_systems()

void cs_f_domain_initialize_cdo_systems

(

void

)

Initialize CDO systems.

cs_f_domain_setup_init_model_context()

void cs_f_domain_setup_init_model_context

(

void

)

When the models have been activated, continue to allocate, add and define structures related to those models This function is called after the user function cs_user_model and before the user function cs_user_parameters.