User functions for input of calculation parameters. More...

#include "cs_defs.h"
#include <assert.h>
#include <math.h>
#include <string.h>
#include <ple_coupling.h>
#include "bft_mem.h"
#include "bft_error.h"
#include "bft_printf.h"
#include "cs_base.h"
#include "cs_cf_model.h"
#include "cs_convection_diffusion.h"
#include "cs_ctwr.h"
#include "cs_fan.h"
#include "cs_field.h"
#include "cs_field_pointer.h"
#include "cs_field_operator.h"
#include "cs_gui_util.h"
#include "cs_grid.h"
#include "cs_internal_coupling.h"
#include "cs_math.h"
#include "cs_mesh.h"
#include "cs_mesh_location.h"
#include "cs_mesh_quantities.h"
#include "cs_halo.h"
#include "cs_halo_perio.h"
#include "cs_log.h"
#include "cs_multigrid.h"
#include "cs_parameters.h"
#include "cs_param_cdo.h"
#include "cs_physical_constants.h"
#include "cs_physical_model.h"
#include "cs_post.h"
#include "cs_post_util.h"
#include "cs_prototypes.h"
#include "cs_rotation.h"
#include "cs_sles.h"
#include "cs_sles_it.h"
#include "cs_thermal_model.h"
#include "cs_time_moment.h"
#include "cs_time_step.h"
#include "cs_turbomachinery.h"
#include "cs_turbulence_model.h"
#include "cs_selector.h"
#include "cs_rad_transfer.h"

Include dependency graph for cs_user_parameters.c:

Functions
void	cs_user_model (void)
	Select physical model options, including user fields. More...

void	cs_user_parameters (cs_domain_t *domain)
	Define or modify general numerical and physical user parameters. More...

void	cs_user_finalize_setup (cs_domain_t *domain)
	Define or modify output user parameters. More...

void	cs_user_linear_solvers (void)
	Define linear solver options. More...

void	cs_user_time_moments (void)
	Define time moments. More...

void	cs_user_internal_coupling (void)
	Define internal coupling options. More...

Detailed Description

User functions for input of calculation parameters.

See Input of calculation parameters (C functions in cs_user_parameters.c) for examples.

Function Documentation

◆ cs_user_finalize_setup()

void cs_user_finalize_setup ( cs_domain_t * domain )

Define or modify output user parameters.

Define or modify output user parameters. For CDO schemes, specify the elements such as properties, advection fields, user-defined equations and modules which have been previously added.

For CDO schemes, this function concludes the setup of properties, equations, source terms...

Parameters

[in,out] domain pointer to a cs_domain_t structure

◆ cs_user_internal_coupling()

void cs_user_internal_coupling ( void )

Define internal coupling options.

Options are usually defined using cs_internal_coupling_add_entity.

◆ cs_user_linear_solvers()

void cs_user_linear_solvers ( void )

Define linear solver options.

This function is called at the setup stage, once user and most model-based fields are defined.

Available native iterative linear solvers include conjugate gradient, Jacobi, BiCGStab, BiCGStab2, and GMRES. For symmetric linear systems, an algebraic multigrid solver is available (and recommended).

External solvers may also be setup using this function, the cs_sles_t mechanism alowing such through user-define functions.

◆ cs_user_model()

void cs_user_model ( void )

Select physical model options, including user fields.

This function is called at the earliest stages of the data setup, so field ids are not available yet.

◆ cs_user_parameters()

void cs_user_parameters ( cs_domain_t * domain )

Define or modify general numerical and physical user parameters.

At the calling point of this function, most model-related most variables and other fields have been defined, so specific settings related to those fields may be set here.

At this stage, the mesh is not built or read yet, so associated data such as field values are not accessible yet, though pending mesh operations and some fields may have been defined.

Parameters

[in,out] domain pointer to a cs_domain_t structure

◆ cs_user_time_moments()

void cs_user_time_moments ( void )

Define time moments.

This function is called at the setup stage, once user and most model-based fields are defined, and before fine control of field output options is defined.

Functions