mapl3g_Generic Module

$ public :: MAPL_GetInternalState

$ $ public :: MAPL_GetOrbit $ public :: MAPL_GetCoordinates $ public :: MAPL_GetLayout

$ interface MAPL_GetInternalState $ procedure :: get_internal_state $ end interface MAPL_GetInternalState

Uses

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Interfaces

public interface MAPL_AddChild

private subroutine add_child_by_name(gridcomp, child_name, setservices, config, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
character(len=*),	intent(in)			::	child_name
class(AbstractUserSetServices),	intent(in)			::	setservices
type(ESMF_HConfig),	intent(inout)			::	config
integer,	intent(out),	optional		::	rc

public interface MAPL_AddExportSpec

private subroutine add_export_spec(gridcomp, unusable, short_name, standard_name, units, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in)			::	short_name
character(len=*),	intent(in)			::	standard_name
character(len=*),	intent(in),	optional		::	units
integer,	intent(out),	optional		::	rc

public interface MAPL_AddImportSpec

private subroutine add_import_spec_legacy(gc, short_name, long_name, units, dims, vlocation, datatype, num_subtiles, refresh_interval, averaging_interval, halowidth, precision, default, restart, ungridded_dims, field_type, staggering, rotation, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	short_name
character(len=*),	intent(in),	optional		::	long_name
character(len=*),	intent(in),	optional		::	units
integer,	intent(in),	optional		::	dims
integer,	intent(in),	optional		::	vlocation
integer,	intent(in),	optional		::	datatype
integer,	intent(in),	optional		::	num_subtiles
integer,	intent(in),	optional		::	refresh_interval
integer,	intent(in),	optional		::	averaging_interval
integer,	intent(in),	optional		::	halowidth
integer,	intent(in),	optional		::	precision
real,	intent(in),	optional		::	default
integer,	intent(in),	optional		::	restart
integer,	intent(in),	optional		::	ungridded_dims(:)
integer,	intent(in),	optional		::	field_type
integer,	intent(in),	optional		::	staggering
integer,	intent(in),	optional		::	rotation
integer,	intent(out),	optional		::	rc

public interface MAPL_AddInternalSpec

private subroutine add_internal_spec(gridcomp, unusable, short_name, standard_name, units, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in)			::	short_name
character(len=*),	intent(in)			::	standard_name
character(len=*),	intent(in),	optional		::	units
integer,	intent(out),	optional		::	rc

public interface MAPL_AddSpec

private subroutine add_spec_basic(gridcomp, variable_spec, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(VariableSpec),	intent(in)			::	variable_spec
integer,	intent(out),	optional		::	rc

private subroutine add_spec_explicit(gridcomp, state_intent, unusable, short_name, standard_name, typekind, ungridded_dims, units, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(ESMF_StateIntent_Flag),	intent(in)			::	state_intent
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in)			::	short_name
character(len=*),	intent(in)			::	standard_name
type(ESMF_TypeKind_Flag),	intent(in),	optional		::	typekind
type(UngriddedDims),	intent(in)			::	ungridded_dims
character(len=*),	intent(in),	optional		::	units
integer,	intent(out),	optional		::	rc

public interface MAPL_ConnectAll

private subroutine gridcomp_connect_all(gridcomp, src_comp, dst_comp, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
character(len=*),	intent(in)			::	src_comp
character(len=*),	intent(in)			::	dst_comp
integer,	intent(out),	optional		::	rc

public interface MAPL_GridCompGet

private subroutine gridcomp_get(gridcomp, unusable, hconfig, outer_meta, logger, registry, geom, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
class(KeywordEnforcer),	intent(in),	optional		::	unusable
type(ESMF_HConfig),	intent(out),	optional		::	hconfig
type(OuterMetaComponent),	intent(out),	optional,	pointer	::	outer_meta
class(Logger),	intent(out),	optional,	pointer	::	logger
type(StateRegistry),	intent(out),	optional,	pointer	::	registry
type(ESMF_Geom),	intent(out),	optional		::	geom
integer,	intent(out),	optional		::	rc

public interface MAPL_GridCompGetOuterMeta

private recursive subroutine gridcomp_get_outer_meta(gridcomp, outer_meta, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(OuterMetaComponent),	intent(out),		pointer	::	outer_meta
integer,	intent(out),	optional		::	rc

public interface MAPL_GridCompIsGeneric

private function gridcomp_is_generic(gridcomp, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(in)			::	gridcomp
integer,	intent(out),	optional		::	rc

Return Value logical

public interface MAPL_GridCompIsUser

private function gridcomp_is_user(gridcomp, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(in)			::	gridcomp
integer,	intent(out),	optional		::	rc

Return Value logical

public interface MAPL_GridCompSetEntryPoint

private subroutine gridcomp_set_entry_point(gridcomp, method_flag, userProcedure, unusable, phase_name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(ESMF_Method_Flag),	intent(in)			::	method_flag
procedure(I_Run)				::	userProcedure
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in),	optional		::	phase_name
integer,	intent(out),	optional		::	rc

public interface MAPL_ResourceGet

private subroutine resource_get_i4_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
integer(kind=ESMF_KIND_I4),	intent(inout)			::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_i8_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
integer(kind=ESMF_KIND_I8),	intent(inout)			::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
integer(kind=ESMF_KIND_I8),	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_r4_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
real(kind=ESMF_KIND_R4),	intent(inout)			::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
real(kind=ESMF_KIND_R4),	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_r8_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
real(kind=ESMF_KIND_R8),	intent(inout)			::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_logical_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
logical,	intent(inout)			::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
logical,	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_i4seq_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
integer(kind=ESMF_KIND_I4),	intent(inout),		dimension(:), allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
integer(kind=ESMF_KIND_I4),	intent(in),	optional,	dimension(:)	::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_i8seq_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
integer(kind=ESMF_KIND_I8),	intent(inout),		dimension(:), allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
integer(kind=ESMF_KIND_I8),	intent(in),	optional,	dimension(:)	::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_r4seq_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
real(kind=ESMF_KIND_R4),	intent(inout),		dimension(:), allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
real(kind=ESMF_KIND_R4),	intent(in),	optional,	dimension(:)	::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_r8seq_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
real(kind=ESMF_KIND_R8),	intent(inout),		dimension(:), allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
real(kind=ESMF_KIND_R8),	intent(in),	optional,	dimension(:)	::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_logical_seq_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
logical,	intent(inout),		dimension(:), allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
logical,	intent(in),	optional,	dimension(:)	::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

private subroutine resource_get_string_gc(gc, keystring, value, unusable, default, value_set, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gc
character(len=*),	intent(in)			::	keystring
character(len=:),	intent(inout),		allocatable	::	value
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in),	optional		::	default
logical,	intent(out),	optional		::	value_set
integer,	intent(out),	optional		::	rc

public interface MAPL_RunChild

private recursive subroutine run_child_by_name(gridcomp, child_name, unusable, phase_name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
character(len=*),	intent(in)			::	child_name
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in),	optional		::	phase_name
integer,	intent(out),	optional		::	rc

public interface MAPL_RunChildren

private recursive subroutine run_children(gridcomp, unusable, phase_name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
class(KeywordEnforcer),	intent(in),	optional		::	unusable
character(len=*),	intent(in)			::	phase_name
integer,	intent(out),	optional		::	rc

public interface MAPL_SetGeometry

private subroutine set_geometry(gridcomp, state_intent, short_name, geom, vertical_grid, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(ESMF_StateIntent_Flag),	intent(in)			::	state_intent
character(len=*),	intent(in)			::	short_name
type(ESMF_Geom),	intent(in),	optional		::	geom
class(VerticalGrid),	intent(in),	optional		::	vertical_grid
integer,	intent(out),	optional		::	rc

Functions

public function get_outer_meta_from_inner_gc(gridcomp, rc) result(outer_meta)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
integer,	intent(out),	optional		::	rc

Return Value type(OuterMetaComponent), pointer

Subroutines

public subroutine MAPL_GridCompSetGeom(gridcomp, geom, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
type(ESMF_Geom),	intent(in)			::	geom
integer,	intent(out),	optional		::	rc

public subroutine MAPL_GridCompSetVerticalGrid(gridcomp, vertical_grid, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GridComp),	intent(inout)			::	gridcomp
class(VerticalGrid),	intent(in)			::	vertical_grid
integer,	intent(out),	optional		::	rc