FV3 Bundle
Private Member Functions | List of all members
interpolator_mod::interpolator Interface Reference

Private Member Functions

subroutine interpolator_4d (clim_type, Time, phalf, interp_data, field_name, is, js, clim_units)
 interpolator_4D receives a field name as input and interpolates the field to model a 4D grid and time axis. More...
 
subroutine interpolator_3d (clim_type, Time, phalf, interp_data, field_name, is, js, clim_units)
 interpolator_3D receives a field name as input and interpolates the field to model a 3D grid and time axis. More...
 
subroutine interpolator_2d (clim_type, Time, interp_data, field_name, is, js, clim_units)
 interpolator_2D receives a field name as input and interpolates the field to model a 2D grid and time axis. More...
 
subroutine interpolator_4d_no_time_axis (clim_type, phalf, interp_data, field_name, is, js, clim_units)
 interpolator_4D_no_time_axis receives a field name as input and interpolates the field to model a 4D grid. More...
 
subroutine interpolator_3d_no_time_axis (clim_type, phalf, interp_data, field_name, is, js, clim_units)
 interpolator_3D_no_time_axis receives a field name as input and interpolates the field to model a 3D grid. More...
 
subroutine interpolator_2d_no_time_axis (clim_type, interp_data, field_name, is, js, clim_units)
 interpolator_2D_no_time_axis receives a field name as input and interpolates the field to model a 2D grid. More...
 

Detailed Description

Definition at line 218 of file interpolator.F90.

Member Function/Subroutine Documentation

◆ interpolator_2d()

subroutine interpolator_mod::interpolator::interpolator_2d ( type(interpolate_type), intent(inout)  clim_type,
type(time_type), intent(in)  Time,
real, dimension(:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_2D receives a field name as input and interpolates the field to model a 2D grid and time axis.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<Time>The model time that you wish to interpolate to
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_2D : You must call interpolator_init before calling interpolator"
FATAL"interpolator_2D 1: file="
FATAL"interpolator_2D 2: file="
FATAL"interpolator_2D 3: file="
FATAL"interpolator_2D 4: file="
FATAL"interpolator_2D 5: file="
FATAL"interpolator_2D : No data from the previous climatology time but we have the next time. How did this happen?"
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 2712 of file interpolator.F90.

◆ interpolator_2d_no_time_axis()

subroutine interpolator_mod::interpolator::interpolator_2d_no_time_axis ( type(interpolate_type), intent(inout)  clim_type,
real, dimension(:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_2D_no_time_axis receives a field name as input and interpolates the field to model a 2D grid.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_2D_no_time_axis : You must call interpolator_init before calling interpolator"
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 3390 of file interpolator.F90.

◆ interpolator_3d()

subroutine interpolator_mod::interpolator::interpolator_3d ( type(interpolate_type), intent(inout)  clim_type,
type(time_type), intent(in)  Time,
real, dimension(:,:,:), intent(in)  phalf,
real, dimension(:,:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_3D receives a field name as input and interpolates the field to model a 3D grid and time axis.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<Time>The model time that you wish to interpolate to
[in]<phalf>The half level model pressure field
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_3D : You must call interpolator_init before calling interpolator"
FATAL"interpolator_3D 1: file="
FATAL"interpolator_3D 2: file="
FATAL"interpolator_3D 3: file="
FATAL"interpolator_3D 4: file="
FATAL"interpolator_3D 5: file="
FATAL"interpolator_3D : No data from the previous climatology time but we have the next time. How did this happen?"
NOTE"Interpolator: model surface pressure is greater than climatology surface pressure for "
NOTE"Interpolator: model top pressure is less than climatology top pressure for "
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 2288 of file interpolator.F90.

◆ interpolator_3d_no_time_axis()

subroutine interpolator_mod::interpolator::interpolator_3d_no_time_axis ( type(interpolate_type), intent(inout)  clim_type,
real, dimension(:,:,:), intent(in)  phalf,
real, dimension(:,:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_3D_no_time_axis receives a field name as input and interpolates the field to model a 3D grid.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<phalf>The half level model pressure field
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_3D_no_time_axis : You must call interpolator_init before calling interpolator"
FATAL"interpolator_mod: cannot use 4D interface to interpolator for this file"
NOTE"Interpolator: model surface pressure is greater than climatology surface pressure for "
NOTE"Interpolator: model top pressure is less than climatology top pressure for "
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 3253 of file interpolator.F90.

◆ interpolator_4d()

subroutine interpolator_mod::interpolator::interpolator_4d ( type(interpolate_type), intent(inout)  clim_type,
type(time_type), intent(in)  Time,
real, dimension(:,:,:), intent(in)  phalf,
real, dimension(:,:,:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_4D receives a field name as input and interpolates the field to model a 4D grid and time axis.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<Time>The model time that you wish to interpolate to
[in]<phalf>The half level model pressure field
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_4D : You must call interpolator_init before calling interpolator"
FATAL"interpolator_mod: cannot use 4D interface to interpolator for this file"
FATAL"interpolator_4D 1: file="
FATAL"interpolator_4D 2: file="
FATAL"interpolator_4D 3: file="
FATAL"interpolator_4D 4: file="
FATAL"interpolator_4D 5: file="
FATAL"interpolator_3D : No data from the previous climatology time but we have the next time. How did this happen?"
NOTE"Interpolator: model surface pressure is greater than climatology surface pressure for "
NOTE"Interpolator: model top pressure is less than climatology top pressure for "
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 1814 of file interpolator.F90.

◆ interpolator_4d_no_time_axis()

subroutine interpolator_mod::interpolator::interpolator_4d_no_time_axis ( type(interpolate_type), intent(inout)  clim_type,
real, dimension(:,:,:), intent(in)  phalf,
real, dimension(:,:,:,:), intent(out)  interp_data,
character(len=*), intent(in)  field_name,
integer, intent(in), optional  is,
integer, intent(in), optional  js,
character(len=*), intent(out), optional  clim_units 
)
private

interpolator_4D_no_time_axis receives a field name as input and interpolates the field to model a 4D grid.

Parameters
[in,out]<clim_type>The interpolate type previously defined by a call to interpolator_init
[in]<field_name>The name of a field that you wish to interpolate
[in]<phalf>The half level model pressure field
[in]<is>OPTIONAL: Index for the physics window
[in]<js>OPTIONAL: Index for the physics window
[out]<interp_data>The model fields with the interpolated climatology data
[out]<clim_units>OPTIONAL: The units of field_name
Exceptions
FATAL"interpolator_4D_no_time_axis : You must call interpolator_init before calling interpolator"
FATAL"interpolator_mod: cannot use 4D interface to interpolator for this file"
NOTE"Interpolator: model surface pressure is greater than surface pressure of input data for "
NOTE"Interpolator: model top pressure is less than surface pressure of input data for "
FATAL"Interpolator: the field name is not contained in this intepolate_type: "

Definition at line 3085 of file interpolator.F90.

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