8.1
general documentation
Data Structures
Here are the data structures with brief descriptions:
[detail level 12]
 Natchem
 Natincl
 Natsoil
 Ncdomod
 Ncs_c_bindings
 Ncs_cf_bindings
 Ncs_f_interfaces
 Ncs_nz_condensation
 Ncs_nz_tagmr
 Nfield
 Nfield_operator
 Nlagran
 Nparall
 Npointe
 Nradiat
 Nrotation
 Nturbomachinery
 Ccs_1d_wall_thermal_local_model_t
 Ccs_1d_wall_thermal_t1D wall thermal module descriptor
 Ccs_adjacency_t
 Ccs_adv_field_t
 Ccs_advection_field_tMain structure to handle an advection field
 Ccs_air_fluid_props_t
 Ccs_ale_data_t
 Ccs_at_opt_interp_t
 Ccs_atmo_chemistry_t
 Ccs_atmo_constants_t
 Ccs_atmo_option_t
 Ccs_basis_func_t
 Ccs_block_dist_info_t
 Ccs_boundary_condition_pm_info_t
 Ccs_boundary_tStructure storing information related to the "physical" boundaries associated with the computational domain
 Ccs_boundary_zone_t
 Ccs_cavitation_parameters_tCavitation model parameters
 Ccs_cdo_assembly_row_t
 Ccs_cdo_assembly_t
 Ccs_cdo_balance_t
 Ccs_cdo_bc_face_t
 Ccs_cdo_connect_t
 Ccs_cdo_quantities_t
 Ccs_cdo_system_block_info_t
 Ccs_cdo_system_block_t
 Ccs_cdo_system_dblock_tStructure associated to the default type of block
 Ccs_cdo_system_helper_t
 Ccs_cdo_system_sblock_tStructure associated to the split type of block
 Ccs_cdo_system_ublock_tStructure associated to the unassembled type of block
 Ccs_cdo_system_xblock_tStructure associated to the extended type of block
 Ccs_cdocb_monolithic_sles_t
 Ccs_cdocb_scaleq_t
 Ccs_cdoeb_vecteq_t
 Ccs_cdofb_monolithic_sles_t
 Ccs_cdofb_navsto_builder_tStructure storing additional arrays related to the building of the Navier-Stokes system
 Ccs_cdofb_vecteq_t
 Ccs_cdovb_vecteq_t
 Ccs_cell_builder_tSet of local and temporary buffers
 Ccs_cell_mesh_tSet of local quantities and connectivities related to a mesh cell
 Ccs_cell_sys_tSet of arrays and local (small) dense matrices related to a mesh cell This is a key structure for building the local algebraic system. This structure belongs to one thread and only
 Ccs_cf_model_tCompressible model general options descriptor
 Ccs_cfd2sys_intersection_t
 Ccs_cfd_sys_cplbc_t
 Ccs_coal_bc_inlet_tInlet definition for pulverized coal combustion
 Ccs_coal_model_t
 Ccs_combustion_gas_model_t
 Ccs_combustion_model_t
 Ccs_ctwr_option_t
 Ccs_data_elec_tPhysical properties for electric model descriptor
 Ccs_data_joule_effect_tStructure to read transformer parameters in dp_ELE
 Ccs_domain_cdo_context_tHigh-level metadata for handling CDO/HHO schemes
 Ccs_domain_tStructure storing the main features of the computational domain and pointers to the main geometrical structures
 Ccs_double_int_t
 Ccs_elec_option_tOption for electric model
 Ccs_enforcement_param_tSet of data defining an enforcement
 Ccs_equation_builder_t
 Ccs_equation_builder_tStore common elements used when building an algebraic system related to an equation
 Ccs_equation_core_tMain structures on which an equation structure relies
 Ccs_equation_param_tSet of parameters to handle an unsteady convection-diffusion-reaction equation with term sources
 Ccs_equation_system_param_tMain structure storing the parameter settings
 Ccs_equation_system_tMain structure to handle a set of coupled equations
 Ccs_equation_t
 Ccs_equation_tMain structure to handle the discretization and the resolution of an equation
 Ccs_face_mesh_light_t
 Ccs_face_mesh_tSet of local quantities and connectivities related to a mesh face Structure used to get a better memory locality. Map existing structure into a more compact one dedicated to a face. Arrays are allocated to n_max_vbyf (= n_max_ebyf). Face-wise numbering is based on the f2e connectivity
 Ccs_field_bc_coeffs_tField boundary condition descriptor (for variables)
 Ccs_field_pointer_array_t
 Ccs_field_tField descriptor
 Ccs_fluid_properties_tFluid properties descriptor
 Ccs_function_t
 Ccs_gas_mix_species_prop_t
 Ccs_gas_mix_tGas mix descriptor
 Ccs_gui_boundary_meg_context_t
 Ccs_gui_volume_meg_context_t
 Ccs_gwf_darcy_flux_t
 Ccs_gwf_darcy_flux_tStructure to handle the Darcy flux
 Ccs_gwf_soil_tMain structure to handle a soil in the groundwater flow module: its definition, the way to update its related properties
 Ccs_gwf_soil_vgm_spf_param_tStructure to handle the Van Genuchten-Mualem model of soil in the case of a single-phase flow in a porous media
 Ccs_gwf_soil_vgm_tpf_param_t
 Ccs_gwf_soil_vgm_tpf_param_tStructure to handle the Van Genuchten-Mualem model of soil in the case of a two-phase flow in a porous media
 Ccs_gwf_sspf_tStructure to handle the modelling of a single-phase flows in a porous media considered as saturated
 Ccs_gwf_tMain set of parameters/structures to manage the groundwater flow (GWF) module. This is an explicit definition of the structure cs_gwf_t
 Ccs_gwf_tpf_tStructure to handle the modelling of miscible or immiscible two-phase flows in a porous media
 Ccs_gwf_tracer_decay_chain_t
 Ccs_gwf_tracer_default_context_t
 Ccs_gwf_tracer_t
 Ccs_gwf_tracer_tSet of parameters describing a tracer structure
 Ccs_gwf_uspf_tStructure to handle the modelling of a single-phase flows in a porous media considered as saturated or not. Several simplifications can be be operated in this context. Only the liquid phase is taken into account
 Ccs_halo_t
 Ccs_hho_builder_t
 Ccs_hodge_param_tStructure storing all metadata/parameters related to the usage of a discrete Hodge operator
 Ccs_hodge_tStructure associated to a discrete Hodge operator *
 Ccs_ibm_object_t
 Ccs_ibm_t
 Ccs_inflow_sem_t
 Ccs_internal_coupling_t
 Ccs_interpol_grid_t
 Ccs_io_sec_header_t
 Ccs_iter_algo_aac_tContext structure for the algorithm called Anderson acceleration
 Ccs_iter_algo_default_t
 Ccs_iter_algo_param_aac_tStructure storing all the parameters to drive the algorithm called Anderson acceleration
 Ccs_iter_algo_tStructure to handle the convergence of an iterative algorithm
 Ccs_join_param_t
 Ccs_join_stats_t
 Ccs_lagr_agglomeration_model_t
 Ccs_lagr_attribute_map_t
 Ccs_lagr_boundary_interactions_t
 Ccs_lagr_brownian_t
 Ccs_lagr_clogging_model_t
 Ccs_lagr_clogging_param_t
 Ccs_lagr_coal_comb_t
 Ccs_lagr_consolidation_model_t
 Ccs_lagr_const_dim_t
 Ccs_lagr_dim_t
 Ccs_lagr_dlvo_param_t
 Ccs_lagr_encrustation_t
 Ccs_lagr_event_attribute_map_t
 Ccs_lagr_event_set_t
 Ccs_lagr_extra_module_t
 Ccs_lagr_fragmentation_model_t
 Ccs_lagr_injection_set_t
 Ccs_lagr_internal_condition_t
 Ccs_lagr_model_t
 Ccs_lagr_particle_counter_t
 Ccs_lagr_particle_set_t
 Ccs_lagr_physico_chemical_t
 Ccs_lagr_precipitation_model_t
 Ccs_lagr_reentrained_model_t
 Ccs_lagr_roughness_param_t
 Ccs_lagr_shape_model_t
 Ccs_lagr_source_terms_t
 Ccs_lagr_specific_physics_t
 Ccs_lagr_stat_options_t
 Ccs_lagr_time_scheme_t
 Ccs_lagr_time_step_t
 Ccs_lagr_zone_data_t
 Ccs_les_balance_rij_tReynolds tensor (Rij) LES balance descriptor
 Ccs_les_balance_tLES balance general options descriptor
 Ccs_les_balance_tui_tTurbulent thermal flux vector (Tui) LES balance descriptor
 Ccs_matrix_row_info_t
 Ccs_measures_set_t
 Ccs_medcoupling_mesh_t
 Ccs_meg_xdef_input_t
 Ccs_mesh_adjacencies_t
 Ccs_mesh_builder_t
 Ccs_mesh_extrude_face_info_t
 Ccs_mesh_extrude_vectors_t
 Ccs_mesh_quantities_t
 Ccs_mesh_t
 Ccs_navsto_ac_tSet of parameters specific for solving the Navier-Stokes system with the "artificial compressibility" algorithm
 Ccs_navsto_monolithic_tSet of parameters specific for solving the Navier-Stokes system with a fully coupled monolithic algorithm
 Ccs_navsto_param_boussinesq_tStructure storing the parameters related to the Boussinesq source term in the momentum equation
 Ccs_navsto_param_sles_tStructure storing the parameters for solving the Navier-Stokes system
 Ccs_navsto_param_tStructure storing the parameters related to the resolution of the Navier-Stokes system
 Ccs_navsto_projection_tSet of parameters specific for solving the Navier-Stokes system with an incremental projection algorithm
 Ccs_navsto_system_tStructure managing the Navier-Stokes system
 Ccs_numbering_t
 Ccs_nvec3_t
 Ccs_opts_t
 Ccs_param_sles_cvg_tSet of parameters to check the convergence (or the divergence) of an iterative process (tolerances or max. number of iterations)
 Ccs_param_sles_mumps_tSet of parameters to specify additional options to MUMPS For more advanced settings, one has to use the cs_user_sles_mumps_hook function. Please also refer to the MUMPS user guide for more details
 Ccs_param_sles_saddle_tStructure storing all metadata related to the resolution of a saddle-point linear system
 Ccs_param_sles_tStructure storing all metadata related to the resolution of a linear system with an iterative solver
 Ccs_physical_constants_tPhysical constants descriptor
 Ccs_porosity_from_scan_opt_t
 Ccs_porosity_ibm_opt_t
 Ccs_pressure_correction_cdo_t
 Ccs_property_data_tStructure storing the evaluation of a property and its related data
 Ccs_property_t
 Ccs_property_tStructure associated to the definition of a property relying on the cs_xdef_t structure
 Ccs_quant_info_t
 Ccs_quant_t
 Ccs_rad_transfer_params_tStructure containing the radiation module parameters
 Ccs_range_set_t
 Ccs_rank_neighbors_t
 Ccs_restart_auxiliary_tAdditional checkpoint/restart files
 Ccs_rotation_tSubdomain rotation description
 Ccs_saddle_block_precond_t
 Ccs_saddle_system_t
 Ccs_sdm_block_t
 Ccs_sdm_t
 Ccs_sles_pc_poly_t
 Ccs_solid_selection_t
 Ccs_solidification_binary_alloy_t
 Ccs_solidification_stefan_t
 Ccs_solidification_t
 Ccs_solidification_voller_t
 Ccs_solving_info_t
 Ccs_space_disc_tSpace discretisation options descriptor
 Ccs_stiffened_gas_t
 Ccs_stl_mesh_info_t
 Ccs_stl_mesh_t
 Ccs_sys_cpl_t
 Ccs_thermal_model_tThermal model descriptor
 Ccs_thermal_system_t
 Ccs_time_control_t
 Ccs_time_scheme_tTime scheme descriptor
 Ccs_time_step_options_tTime step options descriptor
 Ccs_time_step_tTime step descriptor
 Ccs_timer_counter_t
 Ccs_timer_t
 Ccs_tree_node_t
 Ccs_turb_hybrid_model_tHybrid turbulence model descriptor
 Ccs_turb_les_model_tLES turbulence model descriptor
 Ccs_turb_model_tTurbulence model general options descriptor
 Ccs_turb_rans_model_tRANS turbulence model descriptor
 Ccs_turb_ref_values_t
 Ccs_turbulence_param_tStructure storing the parameters related to the resolution of the turbulence modelling. Several members are structures defined in cs_turbulence_model.h as a global variable. The purpose of this structure is to store all parameters in one place
 Ccs_turbulence_t
 Ccs_turbulence_tStructure storing the parameters related to the resolution of the turbulence modelling. Several members are structures defined in cs_turbulence_model.h
 Ccs_velocity_pressure_model_tStokes equation model descriptor
 Ccs_velocity_pressure_param_tInner velocity/pressure iteration options descriptor
 Ccs_vof_parameters_tVOF model parameters. Void fraction variable tracks fluid 2
 Ccs_volume_zone_t
 Ccs_wall_cond_0d_thermal_t
 Ccs_wall_cond_1d_thermal_t
 Ccs_wall_condensation_t
 Ccs_wall_functions_tWall functions descriptor
 Ccs_xdef_analytic_context_tContext structure when a definition by analytic function is used
 Ccs_xdef_array_context_tContext structure when an array is used for the definition
 Ccs_xdef_dof_context_tContext structure when a definition by DoF function is used
 Ccs_xdef_tStructure storing medata for defining a quantity in a very flexible way
 Ccs_xdef_time_func_context_tContext structure when a time step function is used for the definition
 Ccs_zone_t
 Cfvm_box_set_t
 Cfvm_morton_code_t
 Cfvm_nodal_section_t
 Cfvm_nodal_t
 Cfvm_to_ensight_case_file_info_t
 Cfvm_to_histogram_writer_t
 Cfvm_writer_format_t
 Cfvm_writer_section_t
 Cfvm_writer_t