SABER
tools_atlas Module Reference

Generic ranks, dimensions and types. More...

Data Types

interface  field_to_array
 
interface  field_from_array
 
interface  create_atlas_function_space
 
interface  get_atlas_field_size
 

Functions/Subroutines

subroutine atlas_field_to_array_int_r2 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_to_array_real_r2 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_to_array_int_r3 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_to_array_real_r3 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_to_array_logical_r2 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_to_array_logical_r3 (afield, mpl, array, lev2d)
 Convert ATLAS field to field. More...
 
subroutine atlas_field_from_array_int_r2 (afield, mpl, array, lev2d)
 Convert field to ATLAS field, real. More...
 
subroutine atlas_field_from_array_real_r2 (afield, mpl, array, lev2d)
 Convert field to ATLAS field, real. More...
 
subroutine atlas_field_from_array_int_r3 (afield, mpl, array, lev2d)
 Convert field to ATLAS field, real. More...
 
subroutine atlas_field_from_array_real_r3 (afield, mpl, array, lev2d)
 Convert field to ATLAS field, real. More...
 
subroutine atlas_field_from_array_logical_r2 (afield, mpl, array, lev2d)
 Convert ATLAS field from field. More...
 
subroutine atlas_field_from_array_logical_r3 (afield, mpl, array, lev2d)
 Convert ATLAS field from field. More...
 
subroutine atlas_create_atlas_function_space (nmga, lon_mga, lat_mga, afunctionspace)
 Create ATLAS function space from lon/lat. More...
 
integer function atlas_get_atlas_field_size (mpl, afield)
 Get the local horizontal size of an ATLAS field. More...
 

Detailed Description

Generic ranks, dimensions and types.

Subroutines/functions list Instrumentation functions ATLAS tools

Function/Subroutine Documentation

◆ atlas_create_atlas_function_space()

subroutine tools_atlas::atlas_create_atlas_function_space ( integer, intent(in)  nmga,
real(kind_real), dimension(nmga), intent(in)  lon_mga,
real(kind_real), dimension(nmga), intent(in)  lat_mga,
type(atlas_functionspace), intent(out)  afunctionspace 
)
private

Create ATLAS function space from lon/lat.

Parameters
[in]nmgaNumber of nodes
[in]lon_mgaLongitudes [in degrees]
[in]lat_mgaLatitudes [in degrees]
[out]afunctionspaceATLAS function space

Definition at line 933 of file tools_atlas.F90.

◆ atlas_field_from_array_int_r2()

subroutine tools_atlas::atlas_field_from_array_int_r2 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
integer(kind_int), dimension(:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert field to ATLAS field, real.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 529 of file tools_atlas.F90.

◆ atlas_field_from_array_int_r3()

subroutine tools_atlas::atlas_field_from_array_int_r3 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
integer(kind_int), dimension(:,:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert field to ATLAS field, real.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 681 of file tools_atlas.F90.

◆ atlas_field_from_array_logical_r2()

subroutine tools_atlas::atlas_field_from_array_logical_r2 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
logical, dimension(:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field from field.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 834 of file tools_atlas.F90.

◆ atlas_field_from_array_logical_r3()

subroutine tools_atlas::atlas_field_from_array_logical_r3 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
logical, dimension(:,:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field from field.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 883 of file tools_atlas.F90.

◆ atlas_field_from_array_real_r2()

subroutine tools_atlas::atlas_field_from_array_real_r2 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert field to ATLAS field, real.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 604 of file tools_atlas.F90.

◆ atlas_field_from_array_real_r3()

subroutine tools_atlas::atlas_field_from_array_real_r3 ( type(atlas_field), intent(inout)  afield,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:,:), intent(in)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert field to ATLAS field, real.

Parameters
[in,out]afieldATLAS field
[in,out]mplMPI data
[in]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 756 of file tools_atlas.F90.

◆ atlas_field_to_array_int_r2()

subroutine tools_atlas::atlas_field_to_array_int_r2 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
integer(kind_int), dimension(:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 111 of file tools_atlas.F90.

◆ atlas_field_to_array_int_r3()

subroutine tools_atlas::atlas_field_to_array_int_r3 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
integer(kind_int), dimension(:,:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 269 of file tools_atlas.F90.

◆ atlas_field_to_array_logical_r2()

subroutine tools_atlas::atlas_field_to_array_logical_r2 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
logical, dimension(:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 428 of file tools_atlas.F90.

◆ atlas_field_to_array_logical_r3()

subroutine tools_atlas::atlas_field_to_array_logical_r3 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
logical, dimension(:,:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 477 of file tools_atlas.F90.

◆ atlas_field_to_array_real_r2()

subroutine tools_atlas::atlas_field_to_array_real_r2 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 189 of file tools_atlas.F90.

◆ atlas_field_to_array_real_r3()

subroutine tools_atlas::atlas_field_to_array_real_r3 ( type(atlas_field), intent(in)  afield,
type(mpl_type), intent(inout)  mpl,
real(kind_real), dimension(:,:,:), intent(out)  array,
character(len=*), intent(in), optional  lev2d 
)
private

Convert ATLAS field to field.

Parameters
[in]afieldATLAS field
[in,out]mplMPI data
[out]arrayArray, the rightmost dimension being the vertical
[in]lev2dLevel for 2D variables

Definition at line 347 of file tools_atlas.F90.

◆ atlas_get_atlas_field_size()

integer function tools_atlas::atlas_get_atlas_field_size ( type(mpl_type), intent(inout)  mpl,
type(atlas_field), intent(in)  afield 
)
private

Get the local horizontal size of an ATLAS field.

Parameters
[in,out]mplMPI data
[in]afieldATLAS field

Definition at line 974 of file tools_atlas.F90.