Functions to handle the setup of a computational domain High level interface for handling the computation. More...

#include "base/cs_defs.h"
#include <assert.h>
#include "bft/bft_mem.h"
#include "base/cs_ale.h"
#include "base/cs_boundary_zone.h"
#include "base/cs_log.h"
#include "base/cs_log_iteration.h"
#include "base/cs_parall.h"
#include "base/cs_pressure_correction.h"
#include "base/cs_prototypes.h"
#include "base/cs_time_step.h"
#include "cdo/cs_cdo_blas.h"
#include "cdo/cs_cdo_system.h"
#include "cdo/cs_equation.h"
#include "cdo/cs_equation_param.h"
#include "cdo/cs_evaluate.h"
#include "cdo/cs_hodge.h"
#include "cdo/cs_maxwell.h"
#include "cdo/cs_mesh_deform.h"
#include "cdo/cs_navsto_system.h"
#include "cdo/cs_solidification.h"
#include "cdo/cs_source_term.h"
#include "cdo/cs_thermal_system.h"
#include "cdo/cs_walldistance.h"
#include "gui/cs_gui.h"
#include "gwf/cs_gwf.h"
#include "mesh/cs_mesh_location.h"
#include "cdo/cs_domain_setup.h"

Include dependency graph for cs_domain_setup.cpp:

Functions
static void	_set_scheme_flags (cs_domain_t *domain)
	Define the scheme flags for the current computational domain Requirement: domain->cdo_context is alloctated.
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.
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.
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.
void	cs_domain_def_time_step_by_value (cs_domain_t *domain, double dt)
	Define the value of the time step.
void	cs_domain_setup_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.
void	cs_domain_setup_initialize (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.
void	cs_domain_setup_finalize (cs_domain_t *domain)
	Last GUI and then user setup stage of the cs_domain_t structure.
void	cs_domain_setup_finalize_module (cs_domain_t *domain)
	Last user setup stage of the cs_domain_t structure.
void	cs_domain_setup_init_state (cs_domain_t *domain)
	Initialize systems of equations and their related field/properties values according to the user settings.
void	cs_domain_setup_log (const cs_domain_t *domain)
	Summary of the main domain settings.

Detailed Description

Functions to handle the setup of a computational domain High level interface for handling the computation.

Function Documentation

◆ _set_scheme_flags()

void _set_scheme_flags ( cs_domain_t * domain )

static

Define the scheme flags for the current computational domain Requirement: domain->cdo_context is alloctated.

Parameters

[in,out] domain pointer to a cs_domain_t structure

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

◆ cs_domain_setup_finalize()

void cs_domain_setup_finalize ( cs_domain_t * domain )

Last GUI and then user setup stage of the cs_domain_t structure.

Parameters

[in,out] domain pointer to a cs_domain_t struct.

◆ cs_domain_setup_finalize_module()

void cs_domain_setup_finalize_module ( 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_setup_init_cdo_structures()

void cs_domain_setup_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_setup_init_state()

void cs_domain_setup_init_state ( cs_domain_t * domain )

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

Parameters

[in,out] domain pointer to a cs_domain_t structure

◆ cs_domain_setup_initialize()

void cs_domain_setup_initialize ( 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_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