MAPL_SimpleBundleCreate Interface

public interface MAPL_SimpleBundleCreate

Called by

interface~~mapl_simplebundlecreate~~CalledByGraph interface~mapl_simplebundlecreate MAPL_SimpleBundleCreate proc~mapl_simplebundleread MAPL_SimpleBundleRead proc~mapl_simplebundleread->interface~mapl_simplebundlecreate

Module Procedures

private function MAPL_SimpleBundleCreateEmpty(grid, rc, Levs, LevUnits, ptop, delp, name) result(self)

Given inputs, create a SimpleBundle.

Arguments

Type IntentOptional Attributes Name
type(ESMF_Grid), intent(in) :: grid
integer, intent(out), optional :: rc
real(kind=ESMF_KIND_R4), intent(in), optional :: Levs(:)

Vertical coordinates Constant levels
character(len=*), intent(in), optional :: LevUnits

Level units
real(kind=ESMF_KIND_R4), intent(in), optional :: ptop

top pressure (Pa) Lagrangian Control Volume Info
real(kind=ESMF_KIND_R4), intent(in), optional, pointer :: delp(:,:,:)

layer thickness (Pa)
character(len=*), intent(in), optional :: name

name

Return Value type(MAPL_SimpleBundle)

Simple Bundle !rename to simpleBundle

private function MAPL_SimpleBundleCreateFromBundle(Bundle, rc, Levs, LevUnits, ptop, delp, only_vars, strict, name) result(self)

Given an ESMF Bundle, creates a corresponding Simple Bundle. The specification of a vertical grid is optional but useful in many cases. The 1-D Levs will default to the layer number, and units of “1”. Input parameters (ptop,delp) can be used to record the corresponding Lagrangian Control Volume Grid. When delp is not specified, variables DELP or delp are used if present inside the bundle.

Arguments

Type IntentOptional Attributes Name
type(ESMF_FieldBundle), intent(inout), target :: Bundle

ESMF Bundle
integer, intent(out), optional :: rc
real(kind=ESMF_KIND_R4), intent(in), optional :: Levs(:)

Vertical coordinates Constant levels
character(len=*), intent(in), optional :: LevUnits

Level units
real(kind=ESMF_KIND_R4), intent(in), optional :: ptop

top pressure (Pa) Lagrangian Control Volume Info
real(kind=ESMF_KIND_R4), intent(in), optional, pointer :: delp(:,:,:)

layer thickness (Pa)
character(len=*), intent(in), optional :: only_vars

comma separated field names
logical, intent(in), optional :: strict

force name matching, ignored if only_vars is not present
character(len=*), intent(in), optional :: name

name

Return Value type(MAPL_SimpleBundle)

Simple Bundle

private function MAPL_SimpleBundleCreateFromState(State, rc, Levs, LevUnits, ptop, delp, only_vars, strict, name) result(self)

Given an ESMF Staete, creates a corresponding Simple Bundle. The specificatiopn of a vertical grid is optional but useful in many cases. The 1-D Levs will default to the layer number, and units of “1”. Input parameters (ptop,delp) can be used to record the corresponding Lagrangian Control Volume Grid. When delp is not specified, variables DELP or delp are used if present inside the bundle.

IMPORTANT: It is assumed that the ESMF State has a single grid.

Arguments

Type IntentOptional Attributes Name
type(ESMF_State), intent(inout), target :: State

ESMF State
integer, intent(out), optional :: rc
real(kind=ESMF_KIND_R4), intent(in), optional :: Levs(:)

Vertical coordinates Constant levels
character(len=*), intent(in), optional :: LevUnits

Level units
real(kind=ESMF_KIND_R4), intent(in), optional :: ptop

top pressure (Pa) Lagrangian Control Volume Info
real(kind=ESMF_KIND_R4), intent(in), optional, pointer :: delp(:,:,:)

layer thickness (Pa)
character(len=*), intent(in), optional :: only_vars

comma separated field names
logical, intent(in), optional :: strict

force name maching, ignored if only_vars is not present
character(len=*), intent(in), optional :: name

name

Return Value type(MAPL_SimpleBundle)

Simple Bundle