coupler_types.F90 File Reference

#include <file_version.h>

Include dependency graph for coupler_types.F90:

Go to the source code of this file.

Data Types
type	coupler_types_mod::coupler_3d_values_type
type	coupler_types_mod::coupler_3d_field_type
type	coupler_types_mod::coupler_3d_bc_type
type	coupler_types_mod::coupler_2d_values_type
type	coupler_types_mod::coupler_2d_field_type
type	coupler_types_mod::coupler_2d_bc_type
type	coupler_types_mod::coupler_1d_values_type
type	coupler_types_mod::coupler_1d_field_type
type	coupler_types_mod::coupler_1d_bc_type
interface	coupler_types_mod::coupler_type_copy
	This is the interface to spawn one coupler_bc_type into another and then register diagnostics associated with the new type. More...
interface	coupler_types_mod::coupler_type_spawn
	This is the interface to spawn one coupler_bc_type into another. More...
interface	coupler_types_mod::coupler_type_copy_data
	This is the interface to copy the field data from one coupler_bc_type to another of the same rank, size and decomposition. More...
interface	coupler_types_mod::coupler_type_redistribute_data
	This is the interface to redistribute the field data from one coupler_bc_type to another of the same rank and global size, but a different decomposition. More...
interface	coupler_types_mod::coupler_type_rescale_data
	This is the interface to rescale the field data in a coupler_bc_type. More...
interface	coupler_types_mod::coupler_type_increment_data
	This is the interface to increment the field data from one coupler_bc_type with the data from another. Both must have the same horizontal size and decomposition, but a 2d type may be incremented by a 2d or 3d type. More...
interface	coupler_types_mod::coupler_type_extract_data
	This is the interface to extract a field in a coupler_bc_type into an array. More...
interface	coupler_types_mod::coupler_type_set_data
	This is the interface to set a field in a coupler_bc_type from an array. More...
interface	coupler_types_mod::coupler_type_set_diags
	This is the interface to set diagnostics for the arrays in a coupler_bc_type. More...
interface	coupler_types_mod::coupler_type_write_chksums
	This is the interface to write out checksums for the elements of a coupler_bc_type. More...
interface	coupler_types_mod::coupler_type_send_data
	This is the interface to write out diagnostics of the arrays in a coupler_bc_type. More...
interface	coupler_types_mod::coupler_type_data_override
	This is the interface to override the values of the arrays in a coupler_bc_type. More...
interface	coupler_types_mod::coupler_type_register_restarts
	This is the interface to register the fields in a coupler_bc_type to be saved in restart files. More...
interface	coupler_types_mod::coupler_type_restore_state
	This is the interface to read in the fields in a coupler_bc_type that have been saved in restart files. More...
interface	coupler_types_mod::coupler_type_initialized
	This function interface indicates whether a coupler_bc_type has been initialized. More...
interface	coupler_types_mod::coupler_type_destructor
	This is the interface to deallocate any data associated with a coupler_bc_type. More...

Modules
module	coupler_types_mod
	This module contains type declarations for the coupler.

Functions/Subroutines
subroutine, public	coupler_types_mod::coupler_types_init
	Initialize the coupler types. More...
subroutine, public	coupler_types_mod::coupler_type_copy_1d_2d (var_in, var_out, is, ie, js, je, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 1-D to 2-D version for generic coupler_type_copy. More...
subroutine, public	coupler_types_mod::coupler_type_copy_1d_3d (var_in, var_out, is, ie, js, je, kd, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 1-D to 3-D version for generic coupler_type_copy. More...
subroutine	coupler_types_mod::coupler_type_copy_2d_2d (var_in, var_out, is, ie, js, je, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 2-D to 2-D version for generic coupler_type_copy. More...
subroutine	coupler_types_mod::coupler_type_copy_2d_3d (var_in, var_out, is, ie, js, je, kd, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 2-D to 3-D version for generic coupler_type_copy. More...
subroutine	coupler_types_mod::coupler_type_copy_3d_2d (var_in, var_out, is, ie, js, je, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 3-D to 2-D version for generic coupler_type_copy. More...
subroutine	coupler_types_mod::coupler_type_copy_3d_3d (var_in, var_out, is, ie, js, je, kd, diag_name, axes, time, suffix)
	Copy fields from one coupler type to another. 3-D to 3-D version for generic coupler_type_copy. More...
subroutine	coupler_types_mod::ct_spawn_1d_2d (var_in, var, idim, jdim, suffix, as_needed)
	Generate one coupler type using another as a template. 1-D to 2-D version for generic coupler_type_spawn. More...
subroutine	coupler_types_mod::ct_spawn_1d_3d (var_in, var, idim, jdim, kdim, suffix, as_needed)
	Generate one coupler type using another as a template. 1-D to 3-D version for generic CT_spawn. More...
subroutine	coupler_types_mod::ct_spawn_2d_2d (var_in, var, idim, jdim, suffix, as_needed)
	Generate one coupler type using another as a template. 2-D to 2-D version for generic CT_spawn. More...
subroutine	coupler_types_mod::ct_spawn_2d_3d (var_in, var, idim, jdim, kdim, suffix, as_needed)
	Generate one coupler type using another as a template. 2-D to 3-D version for generic CT_spawn. More...
subroutine	coupler_types_mod::ct_spawn_3d_2d (var_in, var, idim, jdim, suffix, as_needed)
	Generate one coupler type using another as a template. 3-D to 2-D version for generic CT_spawn. More...
subroutine	coupler_types_mod::ct_spawn_3d_3d (var_in, var, idim, jdim, kdim, suffix, as_needed)
	Generate one coupler type using another as a template. 3-D to 3-D version for generic CT_spawn. More...
subroutine	coupler_types_mod::ct_copy_data_2d (var_in, var, halo_size, bc_index, field_index, exclude_flux_type, only_flux_type, pass_through_ice)
	Copy all elements of coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_copy_data_3d (var_in, var, halo_size, bc_index, field_index, exclude_flux_type, only_flux_type, pass_through_ice)
	Copy all elements of coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_copy_data_2d_3d (var_in, var, halo_size, bc_index, field_index, exclude_flux_type, only_flux_type, pass_through_ice, ind3_start, ind3_end)
	Copy all elements of coupler_2d_bc_type to coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_redistribute_data_2d (var_in, domain_in, var_out, domain_out, complete)
	Redistribute the data in all elements of a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_redistribute_data_3d (var_in, domain_in, var_out, domain_out, complete)
	Redistributes the data in all elements of one coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_rescale_data_2d (var, scale, halo_size, bc_index, field_index, exclude_flux_type, only_flux_type, pass_through_ice)
	Rescales the fields in the fields in the elements of a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_rescale_data_3d (var, scale, halo_size, bc_index, field_index, exclude_flux_type, only_flux_type, pass_through_ice)
subroutine	coupler_types_mod::ct_increment_data_2d_2d (var_in, var, halo_size, bc_index, field_index, scale_factor, scale_prev, exclude_flux_type, only_flux_type, pass_through_ice)
subroutine	coupler_types_mod::ct_increment_data_3d_3d (var_in, var, halo_size, bc_index, field_index, scale_factor, scale_prev, exclude_flux_type, only_flux_type, pass_through_ice)
subroutine	coupler_types_mod::ct_increment_data_2d_3d (var_in, weights, var, halo_size, bc_index, field_index, scale_factor, scale_prev, exclude_flux_type, only_flux_type, pass_through_ice)
subroutine	coupler_types_mod::ct_extract_data_2d (var_in, bc_index, field_index, array_out, scale_factor, halo_size, idim, jdim)
	Extract a 2d field from a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_extract_data_3d_2d (var_in, bc_index, field_index, k_in, array_out, scale_factor, halo_size, idim, jdim)
subroutine	coupler_types_mod::ct_extract_data_3d (var_in, bc_index, field_index, array_out, scale_factor, halo_size, idim, jdim)
	Extract single 3d field from a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_set_data_2d (array_in, bc_index, field_index, var, scale_factor, halo_size, idim, jdim)
	Set single 2d field in coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_set_data_2d_3d (array_in, bc_index, field_index, k_out, var, scale_factor, halo_size, idim, jdim)
	Set one k-level of a single 3d field in a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_set_data_3d (array_in, bc_index, field_index, var, scale_factor, halo_size, idim, jdim)
	Set a single 3d field in a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_set_diags_2d (var, diag_name, axes, time)
subroutine	coupler_types_mod::ct_set_diags_3d (var, diag_name, axes, time)
	Register the diagnostics of a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_send_data_2d (var, Time)
	Write out all diagnostics of elements of a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_send_data_3d (var, Time)
	Write out all diagnostics of elements of a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_register_restarts_2d (var, bc_rest_files, num_rest_files, mpp_domain, ocean_restart)
subroutine	coupler_types_mod::ct_register_restarts_to_file_2d (var, file_name, rest_file, mpp_domain, varname_prefix)
subroutine	coupler_types_mod::ct_register_restarts_3d (var, bc_rest_files, num_rest_files, mpp_domain, ocean_restart)
subroutine	coupler_types_mod::ct_register_restarts_to_file_3d (var, file_name, rest_file, mpp_domain, varname_prefix)
	Register the fields in a coupler_3d_bc_type to be saved to restart files. More...
subroutine	coupler_types_mod::ct_restore_state_2d (var, directory, all_or_nothing, all_required, test_by_field)
	Reads in fields from restart files into a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_restore_state_3d (var, directory, all_or_nothing, all_required, test_by_field)
	Read in fields from restart files into a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_data_override_2d (gridname, var, Time)
	Potentially override the values in a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_data_override_3d (gridname, var, Time)
	Potentially override the values in a coupler_3d_bc_type. More...
subroutine	coupler_types_mod::ct_write_chksums_2d (var, outunit, name_lead)
	Write out checksums for the elements of a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_write_chksums_3d (var, outunit, name_lead)
	Write out checksums for the elements of a coupler_3d_bc_type. More...
logical function	coupler_types_mod::ct_initialized_1d (var)
	Indicate whether a coupler_1d_bc_type has been initialized. More...
logical function	coupler_types_mod::ct_initialized_2d (var)
	Indicate whether a coupler_2d_bc_type has been initialized. More...
logical function	coupler_types_mod::ct_initialized_3d (var)
	Indicate whether a coupler_3d_bc_type has been initialized. More...
subroutine	coupler_types_mod::ct_destructor_1d (var)
	Deallocate all data associated with a coupler_1d_bc_type. More...
subroutine	coupler_types_mod::ct_destructor_2d (var)
	Deallocate all data associated with a coupler_2d_bc_type. More...
subroutine	coupler_types_mod::ct_destructor_3d (var)
	Deallocate all data associated with a coupler_3d_bc_type. More...

Variables
character(len= *), parameter	coupler_types_mod::mod_name = 'coupler_types_mod'
integer, public	coupler_types_mod::ind_pcair = 1
	The index of the atmospheric concentration. More...
integer, public	coupler_types_mod::ind_u10 = 2
	The index of the 10 m wind speed. More...
integer, public	coupler_types_mod::ind_psurf = 3
	The index of the surface atmospheric pressure. More...
integer, public	coupler_types_mod::ind_alpha = 1
	The index of the solubility array for a tracer. More...
integer, public	coupler_types_mod::ind_csurf = 2
	The index of the ocean surface concentration. More...
integer, public	coupler_types_mod::ind_sc_no = 3
	The index for the Schmidt number for a tracer flux. More...
integer, public	coupler_types_mod::ind_flux = 1
	The index for the tracer flux. More...
integer, public	coupler_types_mod::ind_deltap = 2
	The index for ocean-air gas partial pressure change. More...
integer, public	coupler_types_mod::ind_kw = 3
	The index for the piston velocity. More...
integer, public	coupler_types_mod::ind_flux0 = 4
	The index for the piston velocity. More...
integer, public	coupler_types_mod::ind_deposition = 1
	The index for the atmospheric deposition flux. More...
integer, public	coupler_types_mod::ind_runoff = 1
	The index for a runoff flux. More...