The YAC interface reference (C: yac.h; Fortran: yac_global.F90 and yac_module.F90; Python: yac.pyx)

Table of Contents

• Initialisation
• Reading configuration file
• Interpolation stack generation
• Definition
• Synchronisation of definitions
• Definition of couples
• End of definition
• Data exchange
• Finalisation
• Query routines
• Auxillary routines

Initialisation

yac_cinit yac_cinit_instance	yac_finit (*)	yac.YAC
yac_cinit_comm yac_cinit_comm_instance	yac_finit_comm (*)
yac_cinit_dummy yac_cinit_comm_dummy	yac_finit_dummy (*)
yac_cmpi_handshake	yac_fmpi_handshake
yac_cget_comp_comm	yac_fget_comp_comm	yac.Component.comp_comm
yac_cget_comps_comm yac_cget_comps_comm_instance	yac_fget_comps_comm (*)	yac.YAC.get_comps_comm

Reading configuration file

yac_cread_config_yaml yac_cread_config_yaml_instance	yac_fread_config_yaml (*)	yac.YAC.read_config_yaml
yac_cread_config_json yac_cread_config_json_instance	yac_fread_config_json (*)

Interpolation stack generation

yac_cget_interp_stack_config yac_cfree_interp_stack_config	yac_fget_interp_stack_config yac_ffree_interp_stack_config	yac.InterpolationStack
yac_cadd_interp_stack_config_average yac_cadd_interp_stack_config_ncc yac_cadd_interp_stack_config_nnn yac_cadd_interp_stack_config_conservative yac_cadd_interp_stack_config_spmap yac_cadd_interp_stack_config_hcsbb yac_cadd_interp_stack_config_user_file yac_cadd_interp_stack_config_fixed yac_cadd_interp_stack_config_creep yac_cadd_interp_stack_config_check	yac_fadd_interp_stack_config_average yac_fadd_interp_stack_config_ncc yac_fadd_interp_stack_config_nnn yac_fadd_interp_stack_config_conservative yac_fadd_interp_stack_config_spmap yac_fadd_interp_stack_config_hcsbb yac_fadd_interp_stack_config_user_file yac_fadd_interp_stack_config_fixed yac_fadd_interp_stack_config_creep	yac.InterpolationStack.add_average yac.InterpolationStack.add_ncc yac.InterpolationStack.add_nnn yac.InterpolationStack.add_conservative yac.InterpolationStack.add_spmap yac.InterpolationStack.add_hcsbb yac.InterpolationStack.add_user_file yac.InterpolationStack.add_fixed yac.InterpolationStack.add_creep yac.InterpolationStack.add_check
yac_cadd_interp_stack_config_user_callback (**) yac_cadd_compute_weights_callback (**)

Definition

yac_cdef_calendar	yac_fdef_calendar	yac.def_calendar
yac_cdef_datetime yac_cdef_datetime_instance	yac_fdef_datetime (*)	yac.YAC.def_datetime
yac_cpredef_comp yac_cdef_comp yac_cdef_comp_instance	yac_fpredef_comp (*) yac_fdef_comp (*) yac_fdef_comp_dummy (*)	yac.YAC.predef_comp yac.YAC.def_comp
yac_cdef_comps yac_cdef_comps_instance	yac_fdef_comps (*)
yac_cdef_grid_reg2d yac_cdef_grid_curve2d yac_cdef_grid_unstruct yac_cdef_grid_unstruct_ll	yac_fdef_grid (*)	yac.Reg2dGrid yac.UnstructuredGrid
yac_cdef_points_reg2d yac_cdef_points_curve2d yac_cdef_points_unstruct	yac_fdef_points (*)	yac.Points
yac_cset_core_mask yac_cset_global_index yac_cset_mask	yac_fset_core_mask (*) yac_fset_global_index yac_fset_mask (*)	yac.Grid.set_core_mask yac.Grid.set_global_index yac.Points.set_mask
yac_cdef_mask yac_cdef_mask_named	yac_fdef_mask (*) yac_fdef_mask_named (*)	yac.Grid.def_mask
yac_cdef_field yac_cdef_field_mask	yac_fdef_field yac_fdef_field_mask	yac.Field.create
yac_cenable_field_frac_mask yac_cenable_field_frac_mask_instance	yac_fenable_field_frac_mask (*)	yac.YAC.enable_field_frac_mask
yac_cdef_component_metadata yac_cdef_component_metadata_instance	yac_fdef_component_metadata (*)	yac.YAC.def_component_metadata
yac_cdef_grid_metadata yac_cdef_grid_metadata_instance	yac_fdef_grid_metadata (*)	yac.YAC.def_grid_metadata
yac_cdef_field_metadata yac_cdef_field_metadata_instance	yac_fdef_field_metadata (*)	yac.YAC.def_field_metadata

Synchronisation of definitions

yac_csync_def yac_csync_def_instance

yac_fsync_def (*)

yac.YAC.sync_def

Definition of couples

yac_cdef_couple yac_cdef_couple_instance yac_cdef_couple_custom yac_cdef_couple_custom_instance	yac_fdef_couple (*)	yac.YAC.def_couple
yac_cget_ext_couple_config yac_cfree_ext_couple_config yac_cset_ext_couple_config_weight_file yac_cget_ext_couple_config_weight_file yac_cset_ext_couple_config_mapping_side yac_cget_ext_couple_config_mapping_side yac_cset_ext_couple_config_scale_factor yac_cget_ext_couple_config_scale_factor yac_cset_ext_couple_config_src_mask_names yac_cget_ext_couple_config_src_mask_names yac_cset_ext_couple_config_tgt_mask_name yac_cget_ext_couple_config_mask_name

End of definition

yac_cenddef yac_cenddef_instance	yac_fenddef (*)	yac.YAC.enddef
yac_cenddef_and_emit_config yac_cenddef_and_emit_config_instance	yac_fenddef_and_emit_config (*)

Data exchange

yac_cput yac_cput_ptr_ yac_cput_ yac_cput_frac yac_cput_frac_ptr_ yac_cput_frac_	yac_fput (*)	yac.Field.put yac.Field.put_coro
yac_cget yac_cget_ yac_cget_async yac_cget_async_	yac_fget (*) yac_fget_async (*)	yac.Field.get yac.Field.get_coro
yac_cexchange yac_cexchange_ yac_cexchange_ptr_ yac_cexchange_frac yac_cexchange_frac_ yac_cexchange_frac_ptr_	yac_fexchange (*)
yac_cget_action yac_cupdate	yac_fget_action yac_fupdate	yac.Field.action yac.Field.update
yac_ctest yac_cwait	yac_ftest yac_fwait	yac.Field.test yac.Field.wait

Finalisation

yac_ccleanup yac_ccleanup_instance	yac_fcleanup (*)	yac.YAC.cleanup
yac_cfinalize yac_cfinalize_instance	yac_ffinalize (*)	yac.YAC.__del__

Query routines

yac_cget_default_instance_id	yac_fget_default_instance_id
yac_cget_field_id yac_cget_field_id_instance	yac_fget_field_id (*)	yac.YAC.get_field_id
yac_cget_role_from_field_id yac_cget_field_name_from_field_id yac_cget_timestep_from_field_id yac_cget_collection_size_from_field_id yac_cget_component_name_from_field_id yac_cget_grid_name_from_field_id	yac_fget_field_role (*) yac_fget_field_name (*) yac_fget_field_timestep (*) yac_fget_field_collection_size (*) yac_fget_component_name (*) yac_fget_grid_name (*)	yac.Field.role yac.Field.name yac.Field.timestep yac.Field.collection_size
yac_cget_nbr_comps yac_cget_nbr_comps_instance yac_cget_comp_names yac_cget_comp_names_instance	yac_fget_comp_names (*)	yac.YAC.component_names
yac_cget_nbr_grids yac_cget_nbr_grids_instance yac_cget_grid_names yac_cget_grid_names_instance	yac_fget_grid_names (*)	yac.YAC.grid_names
yac_cget_nbr_fields yac_cget_nbr_fields_instance yac_cget_field_names yac_cget_field_names_instance	yac_fget_field_names (*)	yac.YAC.get_field_names
yac_cget_field_timestep yac_cget_field_timestep_instance	yac_fget_field_timestep (*)
yac_cget_field_frac_mask_fallback_value yac_cget_field_frac_mask_fallback_value_instance	yac_fget_field_frac_mask_fallback_value (*)	yac.YAC.get_field_frac_mask_fallback_value
yac_cget_field_collection_size yac_cget_field_collection_size_instance	yac_fget_field_collection_size (*)	yac.YAC.get_field_collection_size
yac_cget_field_role yac_cget_field_role_instance	yac_fget_field_role (*)
yac_cget_start_datetime yac_cget_start_datetime_instance	yac_fget_start_datetime (*)	yac.YAC.start_datetime
yac_cget_end_datetime yac_cget_end_datetime_instance	yac_fget_end_datetime (*)	yac.YAC.end_datetime
yac_cget_grid_size (**) yac_cget_points_size (**)	yac_fget_grid_size (*) yac_fget_point_size (*)	yac.Points.size
	yac_fcomponent_has_metadata (*) yac_fgrid_has_metadata (*) yac_ffield_has_metadata (*)
yac_cget_component_metadata yac_cget_component_metadata_instance	yac_fget_component_metadata (*)	yac.YAC.get_component_metadata
yac_cget_grid_metadata yac_cget_grid_metadata_instance	yac_fget_grid_metadata (*)	yac.YAC.get_grid_metadata
yac_cget_field_metadata yac_cget_field_metadata_instance	yac_fget_field_metadata (*)	yac.YAC.get_field_metadata

Auxillary routines

yac_cget_version	yac_fget_version	yac.version
yac_abort_message yac_abort yac_restore_default_abort_handler yac_set_abort_handler yac_get_abort_handler yac_get_default_abort_handler yac_set_default_comm	yac_abort_message
yac_ccheck_field_dimensions	yac_fcheck_field_dimensions

Remarks

Functions marked with (*) are overloaded with respect to the data type. See yac_module.F90 for details.

Functions marked with (**) are are only available in the C interface.