programmer's documentation
Functions
cs_prototypes.h File Reference
#include "cs_base.h"
#include "cs_mesh.h"
#include "cs_mesh_quantities.h"
#include "cs_mesh_bad_cells.h"
#include "cs_domain.h"
Include dependency graph for cs_prototypes.h:

Go to the source code of this file.

Functions

void caltri (void)
 
void csinit (const cs_int_t *irgpar, const cs_int_t *nrgpar)
 
void dvvpst (const cs_int_t *nummai, const cs_int_t *numtyp, const cs_int_t *nvar, const cs_int_t *nscal, const cs_int_t *nvlsta, const cs_int_t *nvisbr, const cs_int_t *ncelps, const cs_int_t *nfbrps, const cs_int_t lstcel[], const cs_int_t lstfbr[], cs_real_t tracel[], cs_real_t trafbr[])
 
void findpt (const cs_int_t *ncelet, const cs_int_t *ncel, const cs_real_t *xyzcen, const cs_real_t *xx, const cs_real_t *yy, const cs_real_t *zz, cs_int_t *node, cs_int_t *ndrang)
 
void fische (const cs_int_t *n, const cs_real_t *mu, cs_int_t p[])
 
void haltyp (const cs_int_t *ivoset)
 
void initi1 (void)
 
void memfin (void)
 
void usthht (const cs_int_t *mode, cs_real_t *enthal, cs_real_t *temper)
 
void usvpst (const cs_int_t *nummai, const cs_int_t *nvar, const cs_int_t *nscal, const cs_int_t *nvlsta, const cs_int_t *ncelps, const cs_int_t *nfacps, const cs_int_t *nfbrps, const cs_int_t itypps[3], const cs_int_t lstcel[], const cs_int_t lstfac[], const cs_int_t lstfbr[])
 
void zufall (const cs_int_t *n, const cs_real_t *a)
 
void normalen (const cs_int_t *n, const cs_real_t *x)
 
void cs_lagr_init_zone_class_param (const cs_int_t i_cs_params[], const cs_real_t r_cs_params[])
 
void cs_lagr_define_zone_class_param (cs_int_t class_id, cs_int_t zone_id, const cs_int_t i_cs_params[], const cs_real_t r_cs_params[])
 
void cs_lagr_status (int *model_flag, int *restart_flag, int *frozen_flag)
 
void cs_user_coupling (void)
 
void cs_user_extra_operations (void)
 This function is called at the end of each time step. More...
 
void cs_user_join (void)
 
void cs_user_linear_solvers (void)
 Define linear solver options. More...
 
void cs_user_mesh_bad_cells_tag (cs_mesh_t *mesh, cs_mesh_quantities_t *mesh_quantities)
 
void cs_user_mesh_input (void)
 
void cs_user_mesh_modify (cs_mesh_t *mesh)
 
void cs_user_mesh_thinwall (cs_mesh_t *mesh)
 
void cs_user_mesh_smoothe (cs_mesh_t *mesh)
 
void cs_user_mesh_save (cs_mesh_t *mesh)
 
void cs_user_mesh_warping (void)
 
void cs_user_model (void)
 Select physical model options, including user fields. More...
 
void cs_user_numbering (void)
 
void cs_user_parallel_io (void)
 
void cs_user_partition (void)
 
void cs_user_matrix_tuning (void)
 
void cs_user_parameters (void)
 Define or modify general numerical and physical user parameters. More...
 
void cs_user_periodicity (void)
 
void cs_user_postprocess_writers (void)
 
void cs_user_postprocess_meshes (void)
 
void cs_user_postprocess_activate (int nt_max_abs, int nt_cur_abs, double t_cur_abs)
 
void cs_user_saturne_coupling (void)
 
int cs_user_solver_set (void)
 
void cs_user_solver (const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
 
void cs_user_syrthes_coupling (void)
 
void cs_user_time_moments (void)
 Define time moments. More...
 
void cs_user_turbomachinery (void)
 
void cs_user_turbomachinery_rotor (void)
 
bool cs_user_cdo_activated (void)
 Activate or not the CDO module. More...
 
void cs_user_cdo_add_mesh_locations (void)
 Specify additional mesh locations. More...
 
void cs_user_cdo_init_domain (cs_domain_t *domain)
 Specify for the computational domain: – which type of boundaries closed the computational domain – the settings for the time step. More...
 
void cs_user_cdo_set_domain (cs_domain_t *domain)
 Associate material property and/or convection field to user-defined equations and specify boundary conditions, source terms, initial values for these additional equations. More...
 
cs_cdo_cc_algo_t cs_user_cdo_geometric_settings (void)
 Setup advanced features concerning the way geometric quantities are built. More...
 
void cs_user_cdo_numeric_settings (cs_domain_t *domain)
 Setup advanced features concerning the numerical parameters of the equation resolved during the computation. More...
 
void cs_user_cdo_extra_op (const cs_domain_t *domain)
 Additional operations on results provided by CDO schemes. Define advanced post-processing and/or analysis for instance. More...
 

Function Documentation

void caltri ( void  )
void cs_lagr_define_zone_class_param ( cs_int_t  class_id,
cs_int_t  zone_id,
const cs_int_t  i_cs_params[],
const cs_real_t  r_cs_params[] 
)
void cs_lagr_init_zone_class_param ( const cs_int_t  i_cs_params[],
const cs_real_t  r_cs_params[] 
)
void cs_lagr_status ( int *  model_flag,
int *  restart_flag,
int *  frozen_flag 
)
bool cs_user_cdo_activated ( void  )

Activate or not the CDO module.

(end ignore by Doxygen)

void cs_user_cdo_add_mesh_locations ( void  )

Specify additional mesh locations.

void cs_user_cdo_extra_op ( const cs_domain_t domain)

Additional operations on results provided by CDO schemes. Define advanced post-processing and/or analysis for instance.

Parameters
[in]domainpointer to a cs_domain_t structure

(end ignore by Doxygen)

Parameters
[in]domainpointer to a cs_domain_t structure
cs_cdo_cc_algo_t cs_user_cdo_geometric_settings ( void  )

Setup advanced features concerning the way geometric quantities are built.

Returns
the type of computation to evaluate the cell center
void cs_user_cdo_init_domain ( cs_domain_t domain)

Specify for the computational domain: – which type of boundaries closed the computational domain – the settings for the time step.

Parameters
[in,out]domainpointer to a cs_domain_t structure

Specify for the computational domain: – which type of boundaries closed the computational domain – the settings for the time step.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_user_cdo_numeric_settings ( cs_domain_t domain)

Setup advanced features concerning the numerical parameters of the equation resolved during the computation.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_user_cdo_set_domain ( cs_domain_t domain)

Associate material property and/or convection field to user-defined equations and specify boundary conditions, source terms, initial values for these additional equations.

Parameters
[in,out]domainpointer to a cs_domain_t structure

Associate material property and/or convection field to user-defined equations and specify boundary conditions, source terms, initial values for these additional equations.

Parameters
[in,out]domainpointer to a cs_domain_t structure
void cs_user_coupling ( void  )
void cs_user_extra_operations ( void  )

This function is called at the end of each time step.

It and has a very general purpose, although it is recommended to handle mainly postprocessing or data-extraction type operations.

void cs_user_join ( void  )
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_matrix_tuning ( void  )
void cs_user_mesh_bad_cells_tag ( cs_mesh_t mesh,
cs_mesh_quantities_t mesh_quantities 
)
void cs_user_mesh_input ( void  )
void cs_user_mesh_modify ( cs_mesh_t mesh)
void cs_user_mesh_save ( cs_mesh_t mesh)
void cs_user_mesh_smoothe ( cs_mesh_t mesh)
void cs_user_mesh_thinwall ( cs_mesh_t mesh)
void cs_user_mesh_warping ( void  )
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_numbering ( void  )
void cs_user_parallel_io ( void  )
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_partition ( void  )
void cs_user_periodicity ( void  )
void cs_user_postprocess_activate ( int  nt_max_abs,
int  nt_cur_abs,
double  t_cur_abs 
)
void cs_user_postprocess_meshes ( void  )
void cs_user_postprocess_writers ( void  )
void cs_user_saturne_coupling ( void  )
void cs_user_solver ( const cs_mesh_t mesh,
const cs_mesh_quantities_t mesh_quantities 
)
int cs_user_solver_set ( void  )
void cs_user_syrthes_coupling ( void  )
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.

void cs_user_turbomachinery ( void  )
void cs_user_turbomachinery_rotor ( void  )
void csinit ( const cs_int_t irgpar,
const cs_int_t nrgpar 
)
void dvvpst ( const cs_int_t nummai,
const cs_int_t numtyp,
const cs_int_t nvar,
const cs_int_t nscal,
const cs_int_t nvlsta,
const cs_int_t nvisbr,
const cs_int_t ncelps,
const cs_int_t nfbrps,
const cs_int_t  lstcel[],
const cs_int_t  lstfbr[],
cs_real_t  tracel[],
cs_real_t  trafbr[] 
)
void findpt ( const cs_int_t ncelet,
const cs_int_t ncel,
const cs_real_t xyzcen,
const cs_real_t xx,
const cs_real_t yy,
const cs_real_t zz,
cs_int_t node,
cs_int_t ndrang 
)
void fische ( const cs_int_t n,
const cs_real_t mu,
cs_int_t  p[] 
)
void haltyp ( const cs_int_t ivoset)
void initi1 ( void  )
void memfin ( void  )
void normalen ( const cs_int_t n,
const cs_real_t x 
)
void usthht ( const cs_int_t mode,
cs_real_t enthal,
cs_real_t temper 
)
void usvpst ( const cs_int_t nummai,
const cs_int_t nvar,
const cs_int_t nscal,
const cs_int_t nvlsta,
const cs_int_t ncelps,
const cs_int_t nfacps,
const cs_int_t nfbrps,
const cs_int_t  itypps[3],
const cs_int_t  lstcel[],
const cs_int_t  lstfac[],
const cs_int_t  lstfbr[] 
)
void zufall ( const cs_int_t n,
const cs_real_t a 
)