FV3 Bundle
coupler_types_mod::coupler_type_spawn Interface Reference

This is the interface to spawn one coupler_bc_type into another. More...

Private Member Functions

subroutine 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 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 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 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 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 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...
 

Detailed Description

This is the interface to spawn one coupler_bc_type into another.

Definition at line 213 of file coupler_types.F90.

Member Function/Subroutine Documentation

◆ ct_spawn_1d_2d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_1d_2d ( type(coupler_1d_bc_type), intent(in)  var_in,
type(coupler_2d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 1-D to 2-D version for generic coupler_type_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 535 of file coupler_types.F90.

◆ ct_spawn_1d_3d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_1d_3d ( type(coupler_1d_bc_type), intent(in)  var_in,
type(coupler_3d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
integer, dimension(2), intent(in)  kdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 1-D to 3-D version for generic CT_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]kdimThe array extents of the third dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 630 of file coupler_types.F90.

◆ ct_spawn_2d_2d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_2d_2d ( type(coupler_2d_bc_type), intent(in)  var_in,
type(coupler_2d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 2-D to 2-D version for generic CT_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 734 of file coupler_types.F90.

◆ ct_spawn_2d_3d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_2d_3d ( type(coupler_2d_bc_type), intent(in)  var_in,
type(coupler_3d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
integer, dimension(2), intent(in)  kdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 2-D to 3-D version for generic CT_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,Disordered k-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]kdimThe array extents of the third dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 829 of file coupler_types.F90.

◆ ct_spawn_3d_2d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_3d_2d ( type(coupler_3d_bc_type), intent(in)  var_in,
type(coupler_2d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 3-D to 2-D version for generic CT_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 931 of file coupler_types.F90.

◆ ct_spawn_3d_3d()

subroutine coupler_types_mod::coupler_type_spawn::ct_spawn_3d_3d ( type(coupler_3d_bc_type), intent(in)  var_in,
type(coupler_3d_bc_type), intent(inout)  var,
integer, dimension(4), intent(in)  idim,
integer, dimension(4), intent(in)  jdim,
integer, dimension(2), intent(in)  kdim,
character(len=*), intent(in), optional  suffix,
logical, intent(in), optional  as_needed 
)
private

Generate one coupler type using another as a template. 3-D to 3-D version for generic CT_spawn.

Exceptions
FATAL,The output type has already been initialized
FATAL,The parent type has not been initialized
FATAL,Disordered i-dimension index bound list
FATAL,Disordered j-dimension index bound list
FATAL,Disordered k-dimension index bound list
FATAL,var%bc already assocated
FATAL,var%bc('n')%field already associated
FATAL,var%bc('n')%field('m')%values already associated
Parameters
[in]var_instructure from which to copy information
[in,out]varstructure into which to copy information
[in]idimThe data and computational domain extents of the first dimension in a non-decreasing list
[in]jdimThe data and computational domain extents of the second dimension in a non-decreasing list
[in]kdimThe array extents of the third dimension in a non-decreasing list
[in]suffixoptional suffix to make the name identifier unique
[in]as_neededOnly do the spawn if the target type (var) is not set and the parent type (var_in) is set.

Definition at line 1026 of file coupler_types.F90.


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