coupler_types_mod::coupler_type_copy Interface Reference

This is the interface to spawn one coupler_bc_type into another and then register diagnostics associated with the new type. More...

Private Member Functions
subroutine	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	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_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_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_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_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...

Detailed Description

This is the interface to spawn one coupler_bc_type into another and then register diagnostics associated with the new type.

Definition at line 206 of file coupler_types.F90.

Member Function/Subroutine Documentation

coupler_type_copy_1d_2d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_1d_2d ( type(coupler_1d_bc_type), intent(in)  var_in, type(coupler_2d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 1-D to 2-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 321 of file coupler_types.F90.

coupler_type_copy_1d_3d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_1d_3d ( type(coupler_1d_bc_type), intent(in)  var_in, type(coupler_3d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  kd, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 1-D to 3-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields is exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	kd	third dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 356 of file coupler_types.F90.

coupler_type_copy_2d_2d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_2d_2d ( type(coupler_2d_bc_type), intent(in)  var_in, type(coupler_2d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 2-D to 2-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields is exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 391 of file coupler_types.F90.

coupler_type_copy_2d_3d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_2d_3d ( type(coupler_2d_bc_type), intent(in)  var_in, type(coupler_3d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  kd, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 2-D to 3-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields is exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	kd	third dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 425 of file coupler_types.F90.

coupler_type_copy_3d_2d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_3d_2d ( type(coupler_3d_bc_type), intent(in)  var_in, type(coupler_2d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 3-D to 2-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields is exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 460 of file coupler_types.F90.

coupler_type_copy_3d_3d()

subroutine coupler_types_mod::coupler_type_copy::coupler_type_copy_3d_3d ( type(coupler_3d_bc_type), intent(in)  var_in, type(coupler_3d_bc_type), intent(inout)  var_out, integer, intent(in)  is, integer, intent(in)  ie, integer, intent(in)  js, integer, intent(in)  je, integer, intent(in)  kd, character(len=*), intent(in)  diag_name, integer, dimension(:), intent(in)  axes, type(time_type), intent(in)  time, character(len=*), intent(in), optional  suffix  )

private

Copy fields from one coupler type to another. 3-D to 3-D version for generic coupler_type_copy.

Exceptions

FATAL,Number of output fields exceeds zero

Parameters

[in]	var_in	variable to copy information from
[in,out]	var_out	variable to copy information to
[in]	is	lower bound of first dimension
[in]	ie	upper bound of first dimension
[in]	js	lower bound of second dimension
[in]	je	upper bound of second dimension
[in]	kd	third dimension
[in]	diag_name	name for diagnostic file–if blank, then don't register the fields
[in]	axes	array of axes identifiers for diagnostic variable registration
[in]	time	model time variable for registering diagnostic field
[in]	suffix	optional suffix to make the name identifier unique

Definition at line 494 of file coupler_types.F90.

---

The documentation for this interface was generated from the following file:

• coupler_types.F90