chore: append -dev to version number (#1641)

[FMS.git] / supported_interfaces.md

\ingroup libfms
# Supported Public Interfaces for FMS

List of supported public interfaces and associated types meant for external use through the 'fms' module.
Additional information for this module and others can be found in the Doxygen generated documentation.

### affinity
##### Interfaces
- fms_affinity_init
- fms_affinity_get
- fms_affinity_set

### amip_interp
##### Interfaces
- amip_interp_init
- get_amip_sst
- get_amip_ice
- amip_interp_new
- amip_interp_del
- ASSIGNMENT(=) of amip_interp_types
##### Types
- amip_interp_type

### astronomy
##### Interfaces
- astronomy_init
- get_period
- set_period
- set_orbital_parameters
- get_orbital_parameters
- set_ref_date_of_ae
- get_red_date_of_ae
- diurnal_solar
- daily_mean_solar
- annual_mean_solar
- astronomy_end
- universal_time
- orbital_time

### axis_utils2
##### Interfaces
- get_axis_cart
- get_axis_modulo
- lon_in_range
- tranlon
- frac_index
- nearest_index
- interp_1d
- get_axis_modulo_times
- axis_edges

### block_control
##### Interfaces
- define_blocks
- define_blocks_packed
##### Types
- block_control_type

### column_diagonostics
##### Interfaces
- column_diagnostics_init
- initialize_diagnostic_columns
- column_diagnostics_header
- close_column_diagnostics_units

### coupler_types
##### Interfaces
- coupler_types_init
- coupler_type_copy
- coupler_type_spawn
- coupler_type_set_diags
- coupler_type_write_chksums
- coupler_type_send_data
- coupler_type_data_override
- coupler_type_register_restarts
- coupler_type_restore_stat
- coupler_type_increment_data
- coupler_type_rescale_data
- coupler_type_copy_data
- coupler_type_redistribute_data
- coupler_type_destructor
- coupler_type_initialized
- coupler_type_extract_data
- coupler_type_set_data
##### Types
- coupler_3d_values_type
- coupler_3d_field_type
- coupler_3d_bc_type
- coupler_2d_values_type
- coupler_2d_field_type
- coupler_2d_bc_type
- coupler_1d_values_type
- coupler_1d_field_type
- coupler_1d_bc_type

### ensemble_manager
##### Interfaces
- ensemble_manager_init
- get_ensemble_id
- get_ensemble_size
- get_ensemble_pelist
- ensemble_pelist_setup
- get_ensemble_filter_pelist

### atmos_ocean_fluxes
##### Interfaces
- atmos_ocean_fluxes_init
- atmos_ocean_type_fluxes_init
- aof_set_coupler_flux

### data_override
##### Interfaces
- data_override_init
- data_override
- data_override_unset_domains
- data_override_UG

### diag_integral
##### Interfaces
- diag_integral_init
- diag_integral_field_init
- sum_diag_integral_field
- diag_integral_output
- diag_integral_end

### diag_manager
##### Interfaces
- diag_manager_init
- send_data
- send_tile_averaged_data
- diag_manager_end
- register_diag_field
- register_static_field
- diag_axis_init
- get_base_time
- get_base_date
- need_data
- get_date_dif
- get_diag_global_att
- set_diag_global_att
- diag_field_add_attribute
- diag_field_add_cell_measures
- get_diag_field_id
- diag_axis_add_attribute
- diag_grid_init
- diag_grid_end
- diag_manager_set_time_end
- diag_send_complete
- diag_send_complete_instant

### xgrid
##### Interfaces
- setup_xmap
- set_frac_area
- put_to_xgrid
- get_from_xgrid
- xgrid_count
- some
- conservation_check
- xgrid_init
- get_ocean_model_area_elements
- get_xmap_grid_area
- put_to_xgrid_ug
- get_from_xgrid_ug
- set_frac_area_ug
##### Types
- xmap_type
- grid_box_type

### stock_constants
##### Interfaces
- stocks_report
- stocks_report_init
- stocks_set_init_time

### field_manager
##### Interfaces
- field_manager_init
- field_manager_end
- find_field_index
- get_field_info
- get_field_method
- get_field_methods
- parse
- fm_change_list
- fm_change_root
- fm_dump_list
- fm_exists
- fm_get_index
- fm_get_current_list
- fm_get_length
- fm_get_type
- fm_get_value
- fm_intersection
- fm_init_loop
- fm_loop_over_list
- fm_new_list
- fm_new_value
- fm_reset_loop
- fm_return_root
- fm_modify_name
- fm_query_method
- fm_find_methods
- fm_copy_list
- fm_set_verbosity
##### Types
- method_type
- method_type_short
- method_type_very_short
- fm_list_iter_type

### fm_util
##### Interfaces
- fm_util_start_namelist
- fm_util_end_namelist
- fm_util_check_for_bad_fields
- fm_util_set_caller
- fm_util_reset_caller
- fm_util_set_no_overwrite
- fm_util_reset_no_overwrite
- fm_util_set_good_name_list
- fm_util_reset_good_name_list
- fm_util_get_length
- fm_util_get_integer
- fm_util_get_logical
- fm_util_get_string
- fm_util_get_integer_array
- fm_util_get_logical_array
- fm_util_get_real_array
- fm_util_get_string_array
- fm_util_set_value
- fm_util_set_value_integer_array
- fm_util_set_value_logical_array
- fm_util_set_value_real_array
- fm_util_set_value_string_array
- fm_util_set_value_integer
- fm_util_set_value_logical
- fm_util_set_value_real
- fm_util_set_value_string
- fm_util_get_index_list
- fm_util_get_index_string

### fms(_mod)
##### Interfaces
- fms_init
- fms_end
- error_mesg
- fms_error_handler
- check_nml_error
- monotonic_array
- string_array_index

### fms2_io
##### Interfaces
- fms2_io_init
- open_file
- open_virtual_file
- close_file
- register_axis
- register_field
- register_restart_field
- write_data
- read_data
- write_restart
- write_new_restart
- read_restart
- read_new_restart
- global_att_exists
- variable_att_exists
- register_global_attribute
- register_variable_attribute
- get_global_attribute
- get_variable_attribute
- get_num_dimensions
- get_dimension_names
- dimension_exists
- is_dimension_unlimited
- get_dimension_size
- get_num_variables
- get_variable_names
- variable_exists
- get_variable_num_dimensions
- get_variable_dimension_names
- get_variable_size
- get_compute_domain_dimension_indices
- get_global_io_domain_indices
- get_valid
- is_valid
- get_unlimited_dimension_name
- get_variable_unlimited_dimension_index
- file_exists
- compressed_start_and_count
- get_variable_sense
- get_variable_missing
- get_variable_units
- get_time_calendar
- open_check
- is_registered_to_restart
- check_if_open
- set_fileobj_time_name
- is_dimension_registered
- write_restart_bc
- read_restart_bc
- get_filename_appendix
- set_filename_appendix
- get_instance_filename
- nullify_filename_appendix
- ascii_read
- get_mosaic_tile_file
- parse_mask_table
##### Types
- FmsNetcdfDomainFile_t
- FmsNetcdfDomainFile_t
- FmsNetcdfUnstructuredDomainFile_t
- Valid_t

### horiz_interp
##### Interfaces
- horiz_interp
- horiz_interp_new
- horiz_interp_del
- horiz_interp_init
- horiz_interp_end
- ASSIGNMENT(=) of horiz_interp_types
##### Types
- horiz_interp_type

### interpolator
##### Interfaces
- interpolator_init
- interpolator
- interpolate_type_eq
- obtain_interpolator_time_slices
- unset_interpolator_time_flag
- interpolator_end
- init_clim_diag
- query_interpolator
- interpolator_read_data
##### Types
- interpolate_type

### memutils
##### Interfaces
- memutils_init
- print_memuse_stats

### monin_obukhov
##### Interfaces
- monin_obukhov_init
- monin_obukhov_end
- mo_drag
- mo_profile
- mo_diff
- stable_mix

### mosaic2
##### Interfaces
- get_mosaic_ntiles
- get_mosaic_ncontacts
- get_mosaic_grid_sizes
- get_mosaic_contact
- get_mosaic_xgrid_size
- get_mosaic_xgrid
- calc_mosaic_grid_area
- calc_mosaic_grid_great_circle_area
- is_inside_polygon
- mosaic2_get_mosaic_tile_grid

### mpp
##### Interfaces
- stdin
- stdout
- stderr
- stdlog
- lowercase
- uppercase
- mpp_error
- mpp_error_state
- mpp_set_warn_level
- mpp_sync
- mpp_sync_self
- mpp_set_stack_size
- mpp_pe
- mpp_npes
- mpp_root_pe
- mpp_set_root_pe
- mpp_declare_pelist
- mpp_get_current_pelist
- mpp_set_current_pelist
- mpp_get_current_pelist_name
- mpp_clock_id
- mpp_clock_set_grain
- mpp_record_timing_data
- get_unit
- read_ascii_file
- read_input_nml
- mpp_clock_begin
- mpp_clock_end
- get_ascii_file_num_lines
- mpp_record_time_start
- mpp_record_time_end
- mpp_chksum
- mpp_max
- mpp_min
- mpp_sum
- mpp_transmit
- mpp_send
- mpp_recv
- mpp_sum_ad
- mpp_broadcast
- mpp_init
- mpp_exit
- mpp_gather
- mpp_scatter
- mpp_alltoall
- mpp_type_create
- mpp_type_free
##### Types
- mpp_type

### mpp_utilities
##### Interfaces
- mpp_array_global_min_max

### mpp_memutils
##### Interfaces
- mpp_print_memuse_stats
- mpp_mem_dump
- mpp_memuse_begin
- mpp_memuse_end

### mpp_efp
##### Interfaces
- mpp_reproducing_sum
- mpp_efp_list_sum_across_PEs
- mpp_efp_plus
- mpp_efp_minus
- mpp_efp_to_real
- mpp_real_to_efp
- mpp_efp_real_diff
- mpp_query_efp_overflow_error
- mpp_reset_efp_overflow
- OPERATOR(+), OPERATOR(-), and ASSIGNMENT(=) for mpp_efp_types
##### Types
- mpp_efp_type

### mpp_domains
##### Interfaces
- mpp_domains_set_stack_size
- mpp_get_compute_domain
- mpp_get_compute_domains
- mpp_get_data_domain
- mpp_get_global_domain
- mpp_get_domain_components
- mpp_get_layout
- mpp_get_pelist
- mpp_domain_is_symmetry
- mpp_domain_is_initialized
- mpp_get_neighbor_pe
- mpp_nullify_domain_list
- mpp_set_compute_domain
- mpp_set_data_domain
- mpp_set_global_domain
- mpp_get_memory_domain
- mpp_get_domain_shift
- mpp_domain_is_tile_root_pe
- mpp_get_tile_id
- mpp_get_domain_extents
- mpp_get_current_ntile
- mpp_get_ntile_count
- mpp_get_tile_list
- mpp_get_tile_npes
- mpp_get_domain_root_pe
- mpp_get_tile_pelist
- mpp_get_tile_compute_domains
- mpp_get_num_overlap
- mpp_get_overlap
- mpp_get_io_domain
- mpp_get_domain_pe
- mpp_get_domain_tile_root_pe
- mpp_get_domain_name
- mpp_get_io_domain_layout
- mpp_copy_domain
- mpp_set_domain_symmetry
- mpp_get_update_pelist
- mpp_get_update_size
- mpp_get_domain_npes
- mpp_get_domain_pelist
- mpp_clear_group_update
- mpp_group_update_initialized
- mpp_group_update_is_set
- mpp_get_global_domains
- mpp_global_field
- mpp_global_max
- mpp_global_min
- mpp_global_sum
- mpp_global_sum_tl
- mpp_global_sum_ad
- mpp_broadcast_domain
- mpp_domains_init
- mpp_domains_exit
- mpp_redistribute
- mpp_update_domains
- mpp_check_field
- mpp_start_update_domains
- mpp_complete_update_domains
- mpp_create_group_update
- mpp_do_group_update
- mpp_start_group_update
- mpp_complete_group_update
- mpp_reset_group_update_field
- mpp_update_nest_fine
- mpp_update_nest_coarse
- mpp_get_boundary
- mpp_update_domains_ad
- mpp_get_boundary_ad
- mpp_pass_SG_to_UG
- mpp_pass_UG_to_SG
- mpp_define_layout
- mpp_define_domains
- mpp_modify_domain
- mpp_define_mosaic
- mpp_define_mosaic_pelist
- mpp_define_null_domain
- mpp_mosaic_defined
- mpp_define_io_domain
- mpp_deallocate_domain
- mpp_compute_extent
- mpp_compute_block_extent
- mpp_define_unstruct_domain
- mpp_get_UG_io_domain
- mpp_get_UG_domain_npes
- mpp_get_UG_compute_domain
- mpp_get_UG_domain_tile_id
- mpp_get_UG_domain_pelist
- mpp_get_ug_domain_grid_index
- mpp_get_UG_domain_ntiles
- mpp_get_UG_global_domain
- mpp_global_field_ug
- mpp_get_ug_domain_tile_list
- mpp_get_UG_compute_domains
- mpp_define_null_UG_domain
- mpp_get_UG_domains_index
- mpp_get_UG_SG_domain
- mpp_get_UG_domain_tile_pe_inf
- mpp_define_nest_domains
- mpp_get_C2F_index
- mpp_get_F2C_index
- mpp_get_nest_coarse_domain
- mpp_get_nest_fine_domain
- mpp_is_nest_coarse
- mpp_is_nest_fine
- mpp_get_nest_pelist
- mpp_get_nest_npes
- mpp_get_nest_fine_pelist
- mpp_get_nest_fine_npes
- mpp_domain_UG_is_tile_root_pe
- mpp_deallocate_domainUG
- mpp_get_io_domain_UG_layout
- OPERATOR(.EQ.) for domain2D types
- OPERATOR(.NE.) for domain2D types
- mpp_create_super_grid_domain
##### Types
- domain_axis_spec
- domain1D
- domain2D
- DomainCommunicator2D
- nest_domain_type
- mpp_group_update_type
- domainUG

### random_numbers
##### Interfaces
- initializeRandomNumberStream
- getRandomNumbers
- constructSeed
##### Types
- randomNumberStream

### sat_vapor_pres
##### Interfaces
- lookup_es
- lookup_des
- sat_vapor_pres_init
- lookup_es2
- lookup_des2
- lookup_es2_des2
- lookup_es3
- lookup_des3
- lookup_es3_des3
- lookup_es_des
- compute_qs
- compute_mrs

### time_interp
##### Interfaces
- time_interp_init
- time_interp
- fraction_of_year

### time_interp_external2
##### Interfaces
- init_external_field
- time_interp_external
- time_interp_external_init
- time_interp_external_exit
- get_External_field_size
- get_time_axis
- get_external_field_missing
- set_override_region
- reset_src_data_region
- get_external_fileobj
- reset_src_data_region
- get_external_fileobj

### time_manager
##### Interfaces
- set_time
- increment_time
- decrement_time
- get_time
- interval_alarm
- repeat_alarm
- time_type_to_real
- real_to_time_type
- time_list_error
- set_calendar_type
- get_calendar_type
- set_ticks_per_second
- get_ticks-per_second
- set_date
- get_date
- increment_date
- decrement_date
- days_in_month
- leap_year
- length_of_year
- days_in_year
- day_of_year
- month-name
- valid_calender_types
- time_manager_init
- print_time
- print_date
- set_date_julian
- get_date_julian
- get_date_no_leap
- date_to_string
- all artithmetic operators for time_type
- all logical operators for time_type
##### Type
- time_type

### get_cal_time
##### Interfaces
- get_cal_time

### gaussian_topog
##### Interfaces
- guassian_topog_init
- get_gaussian_topog

### topography
##### Interfaces
- topography_init
- get_topog_mean
- get_topog_stdev
- get_ocean_frac
- get_ocean_mask
- get_water_frac
- get_water_mask

### tracer_manager
##### Interfaces
- tracer_manager_init
- tracer_manager_end
- check_if_prognostic
- get_tracer_indices
- get_tracer_index
- get_tracer_names
- get_tracer_name
- query_method
- set_tracer_atts
- set_tracer_profile
- register_tracers
- get_number_tracers
- ajust_mass
- ajust_positive_def

### tridiagonal
##### Interfaces
- tri_invert
- close_tridiagonal