FV3 Bundle
crtm_cloud_define Module Reference

Data Types

interface  crtm_cloud_inspect
 
type  crtm_cloud_type
 
interface  operator(+)
 
interface  operator(-)
 
interface  operator(==)
 

Functions/Subroutines

pure integer function, public crtm_cloud_categoryid (cloud)
 
pure character(len(cloud_category_name(1))) function, public crtm_cloud_categoryname (cloud)
 
integer function, public crtm_cloud_categorylist (list)
 
elemental logical function, public crtm_cloud_associated (Cloud)
 
elemental subroutine, public crtm_cloud_destroy (Cloud)
 
elemental subroutine, public crtm_cloud_create (Cloud, n_Layers)
 
elemental type(crtm_cloud_type) function, public crtm_cloud_addlayercopy (cld, n_Added_Layers)
 
elemental subroutine, public crtm_cloud_zero (Cloud)
 
logical function, public crtm_cloud_isvalid (Cloud)
 
subroutine scalar_inspect (Cloud, Unit)
 
subroutine rank1_inspect (Cloud, Unit)
 
subroutine rank2_inspect (Cloud, Unit)
 
subroutine, public crtm_cloud_defineversion (Id)
 
elemental logical function, public crtm_cloud_compare (x, y, n_SigFig)
 
elemental subroutine, public crtm_cloud_setlayers (Cloud, n_Layers)
 
integer function, public crtm_cloud_inquirefile (Filename, n_Clouds)
 
integer function, public crtm_cloud_readfile (Filename, Cloud, Quiet, No_Close, n_Clouds, Debug)
 
integer function, public crtm_cloud_writefile (Filename, Cloud, Quiet, No_Close, Debug)
 
elemental logical function crtm_cloud_equal (x, y)
 
elemental type(crtm_cloud_type) function crtm_cloud_add (cld1, cld2)
 
elemental type(crtm_cloud_type) function crtm_cloud_subtract (cld1, cld2)
 
integer function read_record (fid, cloud)
 
integer function write_record (fid, cloud)
 

Variables

character(*), parameter module_version_id = '$Id: CRTM_Cloud_Define.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
 
integer, parameter, public n_valid_cloud_categories = 6
 
integer, parameter, public invalid_cloud = 0
 
integer, parameter, public water_cloud = 1
 
integer, parameter, public ice_cloud = 2
 
integer, parameter, public rain_cloud = 3
 
integer, parameter, public snow_cloud = 4
 
integer, parameter, public graupel_cloud = 5
 
integer, parameter, public hail_cloud = 6
 
integer, dimension(0:n_valid_cloud_categories), parameter cloud_category_list = [ INVALID_CLOUD, WATER_CLOUD, ICE_CLOUD, RAIN_CLOUD, SNOW_CLOUD, GRAUPEL_CLOUD, HAIL_CLOUD ]
 
character(*), dimension(0:n_valid_cloud_categories), parameter, public cloud_category_name = [ 'Invalid', 'Water ', 'Ice ', 'Rain ', 'Snow ', 'Graupel', 'Hail ' ]
 
real(fp), parameter zero = 0.0_fp
 
real(fp), parameter one = 1.0_fp
 
integer, parameter ml = 256
 
character(*), parameter write_error_status = 'DELETE'
 

Function/Subroutine Documentation

◆ crtm_cloud_add()

elemental type(crtm_cloud_type) function crtm_cloud_define::crtm_cloud_add ( type(crtm_cloud_type), intent(in)  cld1,
type(crtm_cloud_type), intent(in)  cld2 
)
private

Definition at line 1359 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ crtm_cloud_addlayercopy()

elemental type(crtm_cloud_type) function, public crtm_cloud_define::crtm_cloud_addlayercopy ( type(crtm_cloud_type), intent(in)  cld,
integer, intent(in)  n_Added_Layers 
)

Definition at line 377 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_associated()

elemental logical function, public crtm_cloud_define::crtm_cloud_associated ( type(crtm_cloud_type), intent(in)  Cloud)

Definition at line 238 of file CRTM_Cloud_Define.f90.

Here is the caller graph for this function:

◆ crtm_cloud_categoryid()

pure integer function, public crtm_cloud_define::crtm_cloud_categoryid ( type(crtm_cloud_type), intent(in)  cloud)

Definition at line 172 of file CRTM_Cloud_Define.f90.

Here is the caller graph for this function:

◆ crtm_cloud_categorylist()

integer function, public crtm_cloud_define::crtm_cloud_categorylist ( integer, dimension(:), intent(out), allocatable  list)

Definition at line 187 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ crtm_cloud_categoryname()

pure character(len(cloud_category_name(1))) function, public crtm_cloud_define::crtm_cloud_categoryname ( type(crtm_cloud_type), intent(in)  cloud)

Definition at line 179 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_compare()

elemental logical function, public crtm_cloud_define::crtm_cloud_compare ( type(crtm_cloud_type), intent(in)  x,
type(crtm_cloud_type), intent(in)  y,
integer, intent(in), optional  n_SigFig 
)

Definition at line 691 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_create()

elemental subroutine, public crtm_cloud_define::crtm_cloud_create ( type(crtm_cloud_type), intent(out)  Cloud,
integer, intent(in)  n_Layers 
)

Definition at line 303 of file CRTM_Cloud_Define.f90.

Here is the caller graph for this function:

◆ crtm_cloud_defineversion()

subroutine, public crtm_cloud_define::crtm_cloud_defineversion ( character(*), intent(out)  Id)

Definition at line 646 of file CRTM_Cloud_Define.f90.

◆ crtm_cloud_destroy()

elemental subroutine, public crtm_cloud_define::crtm_cloud_destroy ( type(crtm_cloud_type), intent(out)  Cloud)

Definition at line 267 of file CRTM_Cloud_Define.f90.

Here is the caller graph for this function:

◆ crtm_cloud_equal()

elemental logical function crtm_cloud_define::crtm_cloud_equal ( type(crtm_cloud_type), intent(in)  x,
type(crtm_cloud_type), intent(in)  y 
)
private

Definition at line 1301 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ crtm_cloud_inquirefile()

integer function, public crtm_cloud_define::crtm_cloud_inquirefile ( character(*), intent(in)  Filename,
integer, intent(out), optional  n_Clouds 
)

Definition at line 821 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ crtm_cloud_isvalid()

logical function, public crtm_cloud_define::crtm_cloud_isvalid ( type(crtm_cloud_type), intent(in)  Cloud)

Definition at line 486 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_readfile()

integer function, public crtm_cloud_define::crtm_cloud_readfile ( character(*), intent(in)  Filename,
type(crtm_cloud_type), dimension(:), intent(out), allocatable  Cloud,
logical, intent(in), optional  Quiet,
logical, intent(in), optional  No_Close,
integer, intent(out), optional  n_Clouds,
logical, intent(in), optional  Debug 
)

Definition at line 959 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_setlayers()

elemental subroutine, public crtm_cloud_define::crtm_cloud_setlayers ( type(crtm_cloud_type), intent(inout)  Cloud,
integer, intent(in)  n_Layers 
)

Definition at line 766 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_subtract()

elemental type(crtm_cloud_type) function crtm_cloud_define::crtm_cloud_subtract ( type(crtm_cloud_type), intent(in)  cld1,
type(crtm_cloud_type), intent(in)  cld2 
)
private

Definition at line 1418 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ crtm_cloud_writefile()

integer function, public crtm_cloud_define::crtm_cloud_writefile ( character(*), intent(in)  Filename,
type(crtm_cloud_type), dimension(:), intent(in)  Cloud,
logical, intent(in), optional  Quiet,
logical, intent(in), optional  No_Close,
logical, intent(in), optional  Debug 
)

Definition at line 1152 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ crtm_cloud_zero()

elemental subroutine, public crtm_cloud_define::crtm_cloud_zero ( type(crtm_cloud_type), intent(inout)  Cloud)

Definition at line 435 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rank1_inspect()

subroutine crtm_cloud_define::rank1_inspect ( type(crtm_cloud_type), dimension(:), intent(in)  Cloud,
integer, intent(in), optional  Unit 
)
private

Definition at line 590 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ rank2_inspect()

subroutine crtm_cloud_define::rank2_inspect ( type(crtm_cloud_type), dimension(:,:), intent(in)  Cloud,
integer, intent(in), optional  Unit 
)
private

Definition at line 605 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

◆ read_record()

integer function crtm_cloud_define::read_record ( integer, intent(in)  fid,
type(crtm_cloud_type), intent(out)  cloud 
)
private

Definition at line 1456 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scalar_inspect()

subroutine crtm_cloud_define::scalar_inspect ( type(crtm_cloud_type), intent(in)  Cloud,
integer, intent(in), optional  Unit 
)
private

Definition at line 567 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_record()

integer function crtm_cloud_define::write_record ( integer, intent(in)  fid,
type(crtm_cloud_type), intent(in)  cloud 
)
private

Definition at line 1526 of file CRTM_Cloud_Define.f90.

Here is the call graph for this function:

Variable Documentation

◆ cloud_category_list

integer, dimension(0:n_valid_cloud_categories), parameter crtm_cloud_define::cloud_category_list = [ INVALID_CLOUD, WATER_CLOUD, ICE_CLOUD, RAIN_CLOUD, SNOW_CLOUD, GRAUPEL_CLOUD, HAIL_CLOUD ]
private

Definition at line 113 of file CRTM_Cloud_Define.f90.

◆ cloud_category_name

character(*), dimension(0:n_valid_cloud_categories), parameter, public crtm_cloud_define::cloud_category_name = [ 'Invalid', 'Water ', 'Ice ', 'Rain ', 'Snow ', 'Graupel', 'Hail ' ]

Definition at line 121 of file CRTM_Cloud_Define.f90.

◆ graupel_cloud

integer, parameter, public crtm_cloud_define::graupel_cloud = 5

Definition at line 111 of file CRTM_Cloud_Define.f90.

◆ hail_cloud

integer, parameter, public crtm_cloud_define::hail_cloud = 6

Definition at line 112 of file CRTM_Cloud_Define.f90.

◆ ice_cloud

integer, parameter, public crtm_cloud_define::ice_cloud = 2

Definition at line 108 of file CRTM_Cloud_Define.f90.

◆ invalid_cloud

integer, parameter, public crtm_cloud_define::invalid_cloud = 0

Definition at line 106 of file CRTM_Cloud_Define.f90.

◆ ml

integer, parameter crtm_cloud_define::ml = 256
private

Definition at line 133 of file CRTM_Cloud_Define.f90.

◆ module_version_id

character(*), parameter crtm_cloud_define::module_version_id = '$Id: CRTM_Cloud_Define.f90 60152 2015-08-13 19:19:13Z paul.vandelst@noaa.gov $'
private

Definition at line 102 of file CRTM_Cloud_Define.f90.

◆ n_valid_cloud_categories

integer, parameter, public crtm_cloud_define::n_valid_cloud_categories = 6

Definition at line 105 of file CRTM_Cloud_Define.f90.

◆ one

real(fp), parameter crtm_cloud_define::one = 1.0_fp
private

Definition at line 131 of file CRTM_Cloud_Define.f90.

◆ rain_cloud

integer, parameter, public crtm_cloud_define::rain_cloud = 3

Definition at line 109 of file CRTM_Cloud_Define.f90.

◆ snow_cloud

integer, parameter, public crtm_cloud_define::snow_cloud = 4

Definition at line 110 of file CRTM_Cloud_Define.f90.

◆ water_cloud

integer, parameter, public crtm_cloud_define::water_cloud = 1

Definition at line 107 of file CRTM_Cloud_Define.f90.

◆ write_error_status

character(*), parameter crtm_cloud_define::write_error_status = 'DELETE'
private

Definition at line 135 of file CRTM_Cloud_Define.f90.

◆ zero

real(fp), parameter crtm_cloud_define::zero = 0.0_fp
private

Definition at line 130 of file CRTM_Cloud_Define.f90.