Data Structures

Here are the data structures with brief descriptions:

[detail level 12]

►Natsoil
Ccategorie_sol	Kind of soil (water, forest, urban ...) and associated constantes
Csoil_tab	Defines the soil constants and variables of the vertical arrays used for the 1D radiative model
Cvariables_sol	Class definition of soil_variables
►Ncdomod
Ccs_f_cdo_post_domain
Ccs_f_cdo_solve_steady_state_domain
Ccs_f_cdo_solve_unsteady_state_domain
Ccs_f_initialize_cdo_systems
►Ncs_c_bindings
Cboundary_conditions_mapped_set	Set mapped boundary conditions for a given field and mapping locator
Ccs_fan_n_fans	Return the number of fans
Ccs_map_name_to_id_destroy	Destroy name to id map structure
Ccs_time_moment_is_active	Return if moment is active (1) or not (0)
Ccs_time_moment_n_moments	Return the number of temporal moments
Cgas_mix_species_prop
Cgwf_soilwater_partition
Cles_filter	Compute filters for dynamic models
Clog_iteration
Clog_l2residual
Cmax_limiter_building
Cparameters_read_restart_info	Read restart metadata
Crestart_check_base_location	Check the locations associated with a restart file
Crestart_destroy	Destroy structure associated with a restart file (and close the file)
Crestart_read_bc_coeffs	Read boundary condition coefficients for all fields from checkpoint
Crestart_read_field_info	Read field metadata from checkpoint
Crestart_read_fields	Loop over all fields and read them in the restart file which id is passed in argument if it matches their "restart_file" key value
Crestart_write_bc_coeffs	Write boundary condition coefficients for all fields to checkpoint
Crestart_write_field_info	Write field metadata to checkpoint
Crestart_write_fields	Loop over all fields and save them in the restart file which id is passed in argument if it matches their "restart_file" key value
Csolving_info
Ctime_moment_field_id	Get field id associated with a given moment
Ctime_moment_log_iteration	Log temporal moments initialization
Ctime_moment_restart_read	Read temporal moments checkpoint information
Ctime_moment_restart_write	Checkpoint temporal moments
Ctime_moment_update_all	Update temporal moments
Ctimer_stats_increment_time_step	Increment time step for timer statistics
Ctimer_stats_set_plot	Enable or disable plotting for a timer statistic
Ctimer_stats_start	Start a timer for a given statistic
Ctimer_stats_stop	Stop a timer for a given statistic
Ctimer_stats_switch	Start a timer for a given statistic, stopping previous timers of the same type which are not a parent, and starting inactive parent timers if necessary
Cturbulence_bc_inlet_hyd_diam	Set inlet boundary condition values for turbulence variables based on a diameter and the reference velocity for a circular duct flow with smooth wall
Cturbulence_bc_inlet_k_eps	Set inlet boundary condition values for turbulence variables based on given k and epsilon values
Cturbulence_bc_inlet_turb_intensity	Set inlet boundary condition values for turbulence variables based on a diameter , a turbulent intensity and the reference velocity for a circular duct flow with smooth wall
Cturbulence_bc_ke_hyd_diam	Calculation of , and from a diameter and the reference velocity for a circular duct flow with smooth wall (use for inlet boundary conditions)
Cturbulence_bc_ke_turb_intensity	Calculation of and from a diameter , a turbulent intensity and the reference velocity for a circular duct flow with smooth wall (for inlet boundary conditions)
Cturbulence_bc_rij_transform	Compute matrix used in the computation of the Reynolds stress tensor boundary conditions
Cturbulence_bc_set_uninit_inlet_k_eps	Set inlet boundary condition values for turbulence variables based on given k and epsilon values only if not initialized already
Cuser_parameters	General user parameters
Cuser_porosity	General user parameters
Cvar_cal_opt
►Ncs_cf_bindings
Ccs_cf_check_density
Ccs_cf_check_internal_energy
Ccs_cf_check_pressure
Ccs_cf_check_temperature
Ccs_cf_hgn_source_terms_step
Ccs_cf_set_thermo_options
Ccs_cf_thermo
Ccs_cf_thermo_beta
Ccs_cf_thermo_c_square
Ccs_cf_thermo_cv
Ccs_cf_thermo_de_from_pt
Ccs_cf_thermo_default_init
Ccs_cf_thermo_dt_from_pe
Ccs_cf_thermo_eps_sup
Ccs_cf_thermo_pe_from_dt
Ccs_cf_thermo_ph_inlet_bc
Ccs_cf_thermo_pt_from_de
Ccs_cf_thermo_s_from_dp
Ccs_cf_thermo_subsonic_outlet_bc
Ccs_cf_thermo_te_from_dp
Ccs_cf_thermo_wall_bc
►Ncs_f_interfaces
Cdiften
Citrgrv
Citrmav
Cmatrdt
Cmatrix
Cpost_boundary_nusselt
Cpost_boundary_thermal_flux
Cpost_stress
Cturrij
Cvistnv
Cvitens
►Nfield
Cfield_allocate_or_map_all	Allocate arrays for all defined fields based on their location
Cfield_clear_key_int_bits	Set integer bits matching a mask to 0 for a given key for a field
Cfield_set_key_double	Assign a floating point value for a given key to a field
Cfield_set_key_int	Assign a floating point value for a given key to a field
Cfield_set_key_int_bits	Set integer bits matching a mask to 1 for a given key for a field
►Nfield_operator
Cfield_gradient_potential	Compute cell gradient of potential field
Cfield_gradient_scalar	Compute cell gradient of scalar field or component of vector or tensor field
Cfield_gradient_tensor	Compute cell gradient of tensor field
Cfield_gradient_vector	Compute cell gradient of vector field
Cfield_set_volume_average	Shift field values in order to set its spatial average to a given value
►Nlagran
Ccs_f_lagr_coal_comb
Ccs_f_lagr_dim_pointers
Ccs_f_lagr_params_pointers
Ccs_f_lagr_source_terms_pointers
Ccs_f_lagr_specific_physics
Ccs_lagr_init_c_arrays	Allocate bound_stat and return fortran compatible pointer
Ccs_lagr_init_par
Ccs_lagr_solve_initialize	Prepare for execution of the Lagrangian model
Ccs_lagr_solve_time_step	Execute one time step of the Lagrangian model
Clagr_restart_write_particle_data	Write particle data to checkpoint
►Nparall
Ccs_parall_allgather_r	Build a global array from each local array in each domain
Cparall_bcast_i	Broadcast an integer in case of parellism
Cparall_bcast_r	Broadcast a real number in case of parellism
Cparbar	Set a barrier on all default communicator processes
Cparbci	Broadcast an array of integers in case of parellism
Cparbcr	Broadcast an array of real numbers in case of parellism
Cparcmn	Compute the global minimum of an integer in case of parellism
Cparcmx	Compute the global maximum of an integer in case of parellism
Cparcpt	Compute the global sum of an integer in case of parellism
Cparfpt	Given an (id, rank, value) tuple, return the local id, rank, and value corresponding to the global minimum value
Cparimn	Compute the global minima of an array of integers in case of parellism
Cparimx	Compute the global maxima of an array of integers in case of parellism
Cparism	Compute the global sums of an array of integers in case of parellism
Cparmax	Compute the global maximum of a real number in case of parellism
Cparmin	Compute the global minimum of a real number in case of parellism
Cparmnl	Minimum value of a real and the value of related array on all default communicator processes
Cparmxl	Maximum value of a real and the value of related array on all default communicator processes
Cparrmn	Compute the global minima of an array of real numbers in case of parellism
Cparrmx	Compute the global maxima of an array of real numbers in case of parellism
Cparrsm	Compute the global sums of an array of real numbers in case of parellism
Cparsom	Compute the global sum of a real number in case of parellism
►Npointe
Cpmapper_double_r1	Container for rank 1 double precision array pointer
Cpmapper_double_r2	Container for rank 2 double precision array pointer
Cpmapper_double_r3	Container for rank 3 double precision array pointer
►Npost
Ccs_post_set_deformable	Configure the post-processing output so that a mesh displacement field may be output automatically
Ccs_user_postprocess_activate	User override of default frequency or calculation end based output
Cpost_activate_by_time_step	Update "active" or "inactive" flag of writers based on the time step
►Nradiat
Ccs_rad_transfer_bcs
Ccs_rad_transfer_finalize
Ccs_rad_transfer_get_pointers
Ccs_rad_transfer_options
Ccs_rad_transfer_read
Ccs_rad_transfer_solve
Ccs_rad_transfer_source_terms
Ccs_rad_transfer_write
►Nrotation
Cadd_coriolis_t	Add the dual tensor of a rotation vector to a tensor
Cadd_coriolis_v	Add a Coriolis term to a local vector
Cangular_velocity	Return angular velocity associated with a rotation
Ccoriolis_t	Compute the dual tensor of a rotation vector
Ccoriolis_v	Compute a Coriolis term for a vector
Crotation_define	Define a global rotation
Crotation_to_array	Copy rotation structure values to an array
Crotation_update_coords	Update coordinates based on a global rotation and time
Crotation_velocity	Compute rotation velocity at given point coordinates
►Nturbomachinery
Cmap_turbomachinery_model
Cmap_turbomachinery_rotor
Cturbomachinery_reinit_i_face_fields
Cturbomachinery_resize_cell_fields
Cturbomachinery_update_mesh
Cconst_node_t	Constants node
Ccs_1d_wall_thermal_local_model_t
Ccs_1d_wall_thermal_t	1D wall thermal module descriptor
Ccs_adjacency_t
Ccs_adv_field_t
Ccs_advection_field_t	Main structure to handle an advection field
Ccs_at_opt_interp_t
Ccs_basis_func_t
Ccs_block_dist_info_t
Ccs_boundary_t	Structure storing information related to the "physical" boundaries that one want to set on the computational domain
Ccs_boundary_zone_t
Ccs_cavitation_parameters_t	Cavitation model parameters
Ccs_cdo_bc_face_t
Ccs_cdo_connect_t
Ccs_cdo_quantities_t
Ccs_cdofb_navsto_builder_t
Ccs_cdofb_vecteq_t
Ccs_cdovb_scaleq_t
Ccs_cell_builder_t	Set of local and temporary buffers useful for building the algebraic system with a cellwise process. This structure belongs to one thread
Ccs_cell_mesh_t	Set of local quantities and connectivities related to a mesh cell This is a key structure for all cellwise processes. This structure belongs to one thread and only. This structure used allows one to get a better memory locality. It maps the existing global mesh and other related structures into a more compact one dedicated to a cell. Arrays are allocated to the max number of related entities (e.g. n_max_vbyc or to n_max_ebyc). The cell-wise numbering is based on the c2v, c2e and c2f connectivity
Ccs_cell_sys_t	Set 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_t	Compressible model general options descriptor
Ccs_combustion_coal_model_t
Ccs_combustion_fuel_model_t
Ccs_combustion_gas_model_t
Ccs_combustion_model_t
Ccs_ctwr_fluid_props_t
Ccs_ctwr_option_t
Ccs_data_elec_t	Physical properties for electric model descriptor
Ccs_data_joule_effect_t	Structure to read transformer parameters in dp_ELE
Ccs_domain_cdo_context_t	High-level metadata for handling CDO/HHO schemes
Ccs_domain_t	Structure storing the main features of the computational domain and pointers to the main geometrical structures
Ccs_double_int_t
Ccs_elec_option_t	Option for electric model
Ccs_equation_balance_t
Ccs_equation_builder_t	Store common elements used when building an algebraic system related to an equation
Ccs_equation_param_t	Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources
Ccs_equation_t	Main structure to handle the discretization and the resolution of an equation
Ccs_equation_t
Ccs_face_mesh_light_t
Ccs_face_mesh_t	Set 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_t	Field boundary condition descriptor (for variables)
Ccs_field_pointer_array_t
Ccs_field_pointer_val_t
Ccs_field_t	Field descriptor
Ccs_fluid_properties_t	Fluid properties descriptor
Ccs_gas_mix_species_prop_t
Ccs_gas_mix_t	Gas mix descriptor
Ccs_gwf_genuchten_update_input_t
Ccs_gwf_saturated_update_input_t
Ccs_gwf_soil_genuchten_param_t
Ccs_gwf_soil_saturated_param_t
Ccs_gwf_soil_t
Ccs_gwf_soilwater_partition_t
Ccs_gwf_std_tracer_input_t
Ccs_gwf_tracer_t
Ccs_halo_t
Ccs_hho_builder_t
Ccs_internal_coupling_t
Ccs_interpol_grid_t
Ccs_io_sec_header_t
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_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_matrix_row_info_t
Ccs_measures_set_t
Ccs_medcoupling_mesh_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_t	Set of parameters specific for solving the Navier-Stokes system with the "artificial compressibility" algorithm
Ccs_navsto_ac_vpp_t	Set of parameters specific for solving the Navier-Stokes system with the "artificial compressibility" solved by the VPP_eps algorithm
Ccs_navsto_monolithic_t	Set of parameters specific for solving the Navier-Stokes system with a fully coupled monolithic algorithm
Ccs_navsto_param_t	Structure storing the parameters related to the resolution of the Navier-Stokes system
Ccs_navsto_projection_t	Set of parameters specific for solving the Navier-Stokes system with an incremental projection algorithm
Ccs_navsto_system_t	Structure managing the Navier-Stokes system
Ccs_navsto_uzawa_t	Set of parameters specific for solving the Navier-Stokes system with a fully coupled algorithm using a Uzawa algorithm and an Augmented Lagrangian approach inside each sub-iteration
Ccs_numbering_t
Ccs_nvec3_t
Ccs_opts_t
Ccs_param_hodge_t
Ccs_param_sles_t	Structure storing all metadata related to the resolution of a linear system with an iterative solver
Ccs_physical_constants_t	Physical constants descriptor
Ccs_piso_t	PISO options descriptor
Ccs_property_t
Ccs_quant_info_t
Ccs_quant_t
Ccs_rad_transfer_params_t	Structure containing the radiation module parameters
Ccs_range_set_t
Ccs_rank_neighbors_t
Ccs_rotation_t	Subdomain rotation description
Ccs_sdm_block_t
Ccs_sdm_t
Ccs_solving_info_t
Ccs_space_disc_t	Space discretisation options descriptor
Ccs_stiffened_gas_t
Ccs_stokes_model_t	Stokes equation model descriptor
Ccs_thermal_model_t	Thermal model descriptor
Ccs_time_step_options_t	Time step options descriptor
Ccs_time_step_t	Time step descriptor
Ccs_timer_counter_t
Ccs_timer_t
Ccs_tree_node_t
Ccs_turb_les_model_t	LES turbulence model descriptor
Ccs_turb_model_t	Turbulence model general options descriptor
Ccs_turb_rans_model_t	RANS turbulence model descriptor
Ccs_turb_ref_values_t
Ccs_var_cal_opt_t	Structure containing the variable calculation options
Ccs_var_t
Ccs_vof_parameters_t	VOF model parameters. Void fraction variable tracks fluid 2
Ccs_volume_zone_t
Ccs_wall_functions_t	Wall functions descriptor
Ccs_xdef_analytic_input_t	Input structure when an analytic function is used for the definition
Ccs_xdef_array_input_t	Input structure when an array is used for the definition
Ccs_xdef_t	Structure storing medata for defining a quantity in a very flexible way
Ccs_xdef_time_func_input_t	Input structure when a time step function is used for the definition
Ccs_zone_t
Cdata_t	Type definition for data of each element contained in the hash table
Cfunc2_node_t	Function with two arguments node
Cfunc_node_t	Function with single argument node
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
Chash_table_t	Structure defining a hash table
Cid_node_t	Identifiers node
Citem	Type definition for each record of the hash table
Cmei_node_t	General node definition
Cmei_tree_t	Structure defining an interpreter for a mathematical expression
Cnode_type_t	Type of a node
Copr_node_t	Operators node