programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
Functions
cs_user_parameters.c File Reference

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_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_physical_constants.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 (void)
 Define or modify general numerical and physical user parameters. More...
 
void cs_user_output (void)
 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...
 
void cs_user_internal_coupling_add_volumes (cs_mesh_t *mesh)
 Define volumes as internal coupling zones. More...
 
void cs_user_internal_coupling_from_disjoint_meshes (cs_mesh_t *mesh)
 Define volumesi from separated meshes as internal coupling zones. More...
 

Detailed Description

User functions for input of calculation parameters.

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

Function Documentation

void cs_user_internal_coupling ( void  )

Define internal coupling options.

Options are usually defined using cs_internal_coupling_add_entity.

void cs_user_internal_coupling_add_volumes ( cs_mesh_t mesh)

Define volumes as internal coupling zones.

These zones will be separated from the rest of the domain using automatically defined thin walls.

Parameters
[in,out]meshpointer to a cs_mesh_t structure
void cs_user_internal_coupling_from_disjoint_meshes ( cs_mesh_t mesh)

Define volumesi from separated meshes as internal coupling zones.

These zones must be disjoint and the face selection criteria must be specified.

Parameters
[in,out]meshpointer to a cs_mesh_t structure
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.

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.

void cs_user_output ( void  )

Define or modify output user parameters.

void cs_user_parameters ( void  )

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.

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.