sfc_climo_gen  1.13.0
 All Data Structures Files Functions Variables Pages
model_grid Module Reference

This module defines the model grid. More...

Public Member Functions

subroutine, public define_model_grid (localpet, npets)
 Define model grid. More...
 
subroutine get_model_info (orog_file, mask, land_frac, lat2d, lon2d, idim, jdim)
 Get model information. More...
 
subroutine, public model_grid_cleanup
 Model grid cleanup. More...
 

Data Fields

type(esmf_field), public data_field_mdl
 ESMF field object that holds the data interpolated to model grid. More...
 
type(esmf_grid), public grid_mdl
 ESMF grid object for the model grid. More...
 
character(len=5), dimension(:),
allocatable, public 
grid_tiles
 Array of model grid tile names. More...
 
integer, public i_mdl
 i dimension of model tile. More...
 
integer, public ij_mdl
 Total number of points on a model tile. More...
 
integer, public j_mdl
 j dimension of model tile. More...
 
type(esmf_field), public land_frac_field_mdl
 ESMF field object that holds the model land fraction. More...
 
type(esmf_field), public latitude_field_mdl
 ESMF field object that holds the model grid latitude. More...
 
type(esmf_field), public longitude_field_mdl
 ESMF field object that holds the model grid longitude. More...
 
type(esmf_field), public mask_field_mdl
 ESMF field object that holds the model land mask. More...
 
real(kind=4), public missing = -999.
 Value assigned to undefined points (i.e., ocean points for a land field). More...
 
integer, public num_tiles
 Total number of model grid tiles. More...
 
type(esmf_field), public vegt_field_mdl
 ESMF field object that holds the vegetation type on the model grid. More...
 

Detailed Description

This module defines the model grid.

Variables named with '_mdl' refer to the model grid.

Author
George Gayno
Date
2018

Definition at line 10 of file model_grid.F90.

Member Function/Subroutine Documentation

subroutine, public model_grid::define_model_grid ( integer, intent(in)  localpet,
integer, intent(in)  npets 
)

Define model grid.

Define the model grid from the mosaic and orography files. Create the ESMF grid object for the model grid.

Parameters
[in]localpetthis mpi task
[in]npetstotal number of mpi tasks
Author
George Gayno
Date
2018

Definition at line 61 of file model_grid.F90.

References utils::error_handler(), get_model_info(), and utils::netcdf_err().

Referenced by driver().

subroutine model_grid::get_model_info ( character(len=*), intent(in)  orog_file,
integer(esmf_kind_i4), dimension(idim,jdim), intent(out)  mask,
real(esmf_kind_r4), dimension(idim,jdim), intent(out)  land_frac,
real(esmf_kind_r4), dimension(idim,jdim), intent(out)  lat2d,
real(esmf_kind_r4), dimension(idim,jdim), intent(out)  lon2d,
integer, intent(in)  idim,
integer, intent(in)  jdim 
)

Get model information.

Read model land/sea mask, land fraction and lat/lon from the orography file.

Parameters
[in]orog_filethe orography file
[out]maskland/sea mask 0-all non-land; 1-some land.
[out]land_fracland fraction between 0 and 1.
[out]lat2dlatitude
[out]lon2dlongitude
[in]idimi dimension of the model tile
[in]jdimj dimension of the model tile
Author
George Gayno
Date
2018

Definition at line 311 of file model_grid.F90.

References utils::error_handler(), and utils::netcdf_err().

Referenced by define_model_grid().

subroutine, public model_grid::model_grid_cleanup ( )

Model grid cleanup.

Free up memory associated with this module.

Author
George Gayno
Date
2018

Definition at line 423 of file model_grid.F90.

Referenced by driver().

Field Documentation

type(esmf_field), public model_grid::data_field_mdl

ESMF field object that holds the data interpolated to model grid.

Definition at line 29 of file model_grid.F90.

type(esmf_grid), public model_grid::grid_mdl

ESMF grid object for the model grid.

Definition at line 28 of file model_grid.F90.

character(len=5), dimension(:), allocatable, public model_grid::grid_tiles

Array of model grid tile names.

Definition at line 18 of file model_grid.F90.

integer, public model_grid::i_mdl

i dimension of model tile.

Definition at line 20 of file model_grid.F90.

integer, public model_grid::ij_mdl

Total number of points on a model tile.

Definition at line 22 of file model_grid.F90.

integer, public model_grid::j_mdl

j dimension of model tile.

Definition at line 21 of file model_grid.F90.

type(esmf_field), public model_grid::land_frac_field_mdl

ESMF field object that holds the model land fraction.

When running with fractional grids, will be between zero and one. For non- fractional grids, will contain a fill value.

Definition at line 31 of file model_grid.F90.

type(esmf_field), public model_grid::latitude_field_mdl

ESMF field object that holds the model grid latitude.

Definition at line 41 of file model_grid.F90.

type(esmf_field), public model_grid::longitude_field_mdl

ESMF field object that holds the model grid longitude.

Definition at line 43 of file model_grid.F90.

type(esmf_field), public model_grid::mask_field_mdl

ESMF field object that holds the model land mask.

Equal to '1' if point is partial or all land. Equal to zero is point is all non-land.

Definition at line 37 of file model_grid.F90.

real(kind=4), public model_grid::missing = -999.

Value assigned to undefined points (i.e., ocean points for a land field).

Definition at line 25 of file model_grid.F90.

integer, public model_grid::num_tiles

Total number of model grid tiles.

Definition at line 23 of file model_grid.F90.

type(esmf_field), public model_grid::vegt_field_mdl

ESMF field object that holds the vegetation type on the model grid.

Definition at line 45 of file model_grid.F90.


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