StateItemSpec Derived Type

type, public, abstract :: StateItemSpec


Inherits

type~~stateitemspec~~InheritsGraph type~stateitemspec StateItemSpec StringVector StringVector type~stateitemspec->StringVector raw_dependencies type~actualptvector ActualPtVector type~stateitemspec->type~actualptvector dependencies type~aspectcollection AspectCollection type~stateitemspec->type~aspectcollection aspects type~vector_wrapper~10 vector_wrapper type~actualptvector->type~vector_wrapper~10 elements type~attributesaspect AttributesAspect type~aspectcollection->type~attributesaspect attributes_aspect type~frequencyaspect FrequencyAspect type~aspectcollection->type~frequencyaspect frequency_aspect type~geomaspect GeomAspect type~aspectcollection->type~geomaspect geom_aspect type~typekindaspect TypekindAspect type~aspectcollection->type~typekindaspect typekind_aspect type~ungriddeddimsaspect UngriddedDimsAspect type~aspectcollection->type~ungriddeddimsaspect ungridded_dims_aspect type~unitsaspect UnitsAspect type~aspectcollection->type~unitsaspect units_aspect type~verticalgridaspect VerticalGridAspect type~aspectcollection->type~verticalgridaspect vertical_grid_aspect type~attributesaspect->StringVector attribute_names type~stateitemaspect StateItemAspect type~attributesaspect->type~stateitemaspect ESMF_TimeInterval ESMF_TimeInterval type~frequencyaspect->ESMF_TimeInterval timestep_ type~frequencyaspect->type~stateitemaspect ESMF_Geom ESMF_Geom type~geomaspect->ESMF_Geom geom EsmfRegridderParam EsmfRegridderParam type~geomaspect->EsmfRegridderParam regridder_param type~horizontaldimsspec HorizontalDimsSpec type~geomaspect->type~horizontaldimsspec horizontal_dims_spec type~geomaspect->type~stateitemaspect ESMF_TypeKind_Flag ESMF_TypeKind_Flag type~typekindaspect->ESMF_TypeKind_Flag typekind type~typekindaspect->type~stateitemaspect type~ungriddeddimsaspect->type~stateitemaspect type~ungriddeddims UngriddedDims type~ungriddeddimsaspect->type~ungriddeddims ungridded_dims type~unitsaspect->type~stateitemaspect type~actualconnectionpt ActualConnectionPt type~vector_wrapper~10->type~actualconnectionpt item type~verticalgridaspect->ESMF_Geom geom type~verticalgridaspect->ESMF_TypeKind_Flag typekind type~verticalgridaspect->type~stateitemaspect type~verticaldimspec VerticalDimSpec type~verticalgridaspect->type~verticaldimspec vertical_dim_spec type~verticalgrid VerticalGrid type~verticalgridaspect->type~verticalgrid vertical_grid type~verticalregridmethod VerticalRegridMethod type~verticalgridaspect->type~verticalregridmethod regrid_method type~virtualconnectionpt VirtualConnectionPt type~actualconnectionpt->type~virtualconnectionpt v_pt type~ungriddeddimvector UngriddedDimVector type~ungriddeddims->type~ungriddeddimvector dim_specs

Inherited by

type~~stateitemspec~~InheritedByGraph type~stateitemspec StateItemSpec type~actualptstateitemspecpair ActualPtStateItemSpecPair type~actualptstateitemspecpair->type~stateitemspec second type~bracketspec BracketSpec type~bracketspec->type~stateitemspec type~fieldspec~2 FieldSpec type~bracketspec->type~fieldspec~2 reference_spec, field_specs type~fieldspec~2->type~stateitemspec type~invalidspec InvalidSpec type~invalidspec->type~stateitemspec type~mockitemspec MockItemSpec type~mockitemspec->type~stateitemspec type~servicespec ServiceSpec type~servicespec->type~stateitemspec type~stateitemspecptr StateItemSpecPtr type~servicespec->type~stateitemspecptr dependency_specs type~stateitemextension StateItemExtension type~stateitemextension->type~stateitemspec spec type~stateitemspecpair StateItemSpecPair type~stateitemspecpair->type~stateitemspec second type~stateitemspecptr->type~stateitemspec ptr type~statespec StateSpec type~statespec->type~stateitemspec type~vector_wrapper~22 vector_wrapper type~vector_wrapper~22->type~stateitemspec item type~virtualptstateitemspecpair VirtualPtStateItemSpecPair type~virtualptstateitemspecpair->type~stateitemspec second type~wildcardspec WildcardSpec type~wildcardspec->type~stateitemspec reference_spec type~wildcardspec->type~stateitemspec type~actualptspecptrpair ActualPtSpecPtrPair type~actualptspecptrpair->type~stateitemspecptr second type~map_s_node~12 map_s_Node type~map_s_node~12->type~actualptstateitemspecpair value type~map_s_node~13 map_s_Node type~map_s_node~13->type~stateitemspecpair value type~map_s_node~15 map_s_Node type~map_s_node~15->type~virtualptstateitemspecpair value type~stateitemextensionptr StateItemExtensionPtr type~stateitemextensionptr->type~stateitemextension ptr type~stateitemvector StateItemVector type~stateitemvector->type~vector_wrapper~22 elements type~stateitemvectoriterator StateItemVectorIterator type~stateitemvectoriterator->type~vector_wrapper~22 elements type~vector_wrapper~21 vector_wrapper type~vector_wrapper~21->type~stateitemspecptr item type~vector_wrapper~24 vector_wrapper type~vector_wrapper~24->type~stateitemextension item type~virtualptstateitemptrpair VirtualPtStateItemPtrPair type~virtualptstateitemptrpair->type~stateitemspecptr second

Type-Bound Procedures

procedure(I_add_to_bundle), public, deferred :: add_to_bundle

  • subroutine I_add_to_bundle(this, bundle, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this
    type(ESMF_FieldBundle), intent(inout) :: bundle
    integer, intent(out), optional :: rc

procedure(I_add_to_state), public, deferred :: add_to_state

  • subroutine I_add_to_state(this, multi_state, actual_pt, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this
    type(MultiState), intent(inout) :: multi_state
    type(ActualConnectionPt), intent(in) :: actual_pt
    integer, intent(out), optional :: rc

procedure(I_allocate), public, deferred :: allocate

  • subroutine I_allocate(this, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    integer, intent(out), optional :: rc

procedure(I_can_connect), public, deferred :: can_connect_to

  • function I_can_connect(this, src_spec, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this
    class(StateItemSpec), intent(in) :: src_spec
    integer, intent(out), optional :: rc

    Return Value logical

procedure(I_connect), public, deferred :: connect_to

  • subroutine I_connect(this, src_spec, actual_pt, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    class(StateItemSpec), intent(inout) :: src_spec
    type(ActualConnectionPt), intent(in) :: actual_pt
    integer, intent(out), optional :: rc

procedure(I_create), public, deferred :: create

  • subroutine I_create(this, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    integer, intent(out), optional :: rc

procedure(I_destroy), public, deferred :: destroy

  • subroutine I_destroy(this, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    integer, intent(out), optional :: rc

procedure, public :: get_aspect

  • private function get_aspect(this, name, rc) result(aspect)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in), target :: this
    character(len=*), intent(in) :: name
    integer, intent(out), optional :: rc

    Return Value class(StateItemAspect), pointer

procedure, public :: get_aspect_order

  • private function get_aspect_order(src_spec, dst_spec) result(names)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: src_spec
    class(StateItemSpec), intent(in) :: dst_spec

    Return Value type(StringVector)

procedure, public :: get_aspect_priorities

  • private function get_aspect_priorities(src_spec, dst_spec) result(order)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: src_spec
    class(StateItemSpec), intent(in) :: dst_spec

    Return Value character(len=:), allocatable

procedure, public :: get_aspects

  • private function get_aspects(this) result(aspects)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in), target :: this

    Return Value type(AspectCollection), pointer

procedure, public :: get_dependencies

  • private function get_dependencies(this) result(dependencies)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this

    Return Value type(ActualPtVector)

procedure, public :: get_raw_dependencies

  • private function get_raw_dependencies(this) result(raw_dependencies)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this

    Return Value type(StringVector)

procedure, public, non_overridable :: is_active

  • private pure function is_active(this)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this

    Return Value logical

procedure, public, non_overridable :: is_allocated

  • private pure function is_allocated(this)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this

    Return Value logical

procedure, public :: make_extension

  • private function make_extension(this, aspect_name, aspect, rc) result(new_spec)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this
    character(len=*), intent(in) :: aspect_name
    class(StateItemAspect), intent(in) :: aspect
    integer, intent(out), optional :: rc

    Return Value class(StateItemSpec), allocatable

procedure, public, non_overridable :: set_active

  • private pure subroutine set_active(this, active)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    logical, intent(in), optional :: active

procedure, public, non_overridable :: set_allocated

  • private pure subroutine set_allocated(this, allocated)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    logical, intent(in), optional :: allocated

procedure, public :: set_aspect

  • private subroutine set_aspect(this, aspect, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout), target :: this
    class(StateItemAspect), intent(in) :: aspect
    integer, intent(out), optional :: rc

procedure, public :: set_dependencies

  • private subroutine set_dependencies(this, dependencies)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    type(ActualPtVector), intent(in) :: dependencies

procedure(I_set_geometry), public, deferred :: set_geometry

  • subroutine I_set_geometry(this, geom, vertical_grid, timestep, rc) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    type(ESMF_Geom), intent(in), optional :: geom
    class(VerticalGrid), intent(in), optional :: vertical_grid
    type(ESMF_TimeInterval), intent(in), optional :: timestep
    integer, intent(out), optional :: rc

procedure, public :: set_raw_dependencies

  • private subroutine set_raw_dependencies(this, raw_dependencies)

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(inout) :: this
    type(StringVector), intent(in) :: raw_dependencies

generic, public :: write(formatted) => write_formatted

  • private subroutine write_formatted(this, unit, iotype, v_list, iostat, iomsg)

    Arguments

    Type IntentOptional Attributes Name
    class(BracketSpec), intent(in) :: this
    integer, intent(in) :: unit
    character(len=*), intent(in) :: iotype
    integer, intent(in) :: v_list(:)
    integer, intent(out) :: iostat
    character(len=*), intent(inout) :: iomsg

procedure(I_write_formatted), public, deferred :: write_formatted

  • subroutine I_write_formatted(this, unit, iotype, v_list, iostat, iomsg) Prototype

    Arguments

    Type IntentOptional Attributes Name
    class(StateItemSpec), intent(in) :: this
    integer, intent(in) :: unit
    character(len=*), intent(in) :: iotype
    integer, intent(in) :: v_list(:)
    integer, intent(out) :: iostat
    character(len=*), intent(inout) :: iomsg

Source Code

   type, abstract :: StateItemSpec
      private

      logical :: active = .false.
      logical :: allocated = .false.
      type(StringVector) :: raw_dependencies
      type(ActualPtVector) :: dependencies

      type(AspectCollection) :: aspects
   contains

      procedure(I_create), deferred :: create
      procedure(I_destroy), deferred :: destroy
      procedure(I_allocate), deferred :: allocate

      procedure(I_connect), deferred :: connect_to
      procedure(I_can_connect), deferred :: can_connect_to

      procedure :: get_aspect_order ! as string vector
!#      procedure(I_get_aspect_priorities), deferred :: get_aspect_priorities ! as colon-separated string
      procedure :: get_aspect_priorities ! default implementation as aid to refactoring
!#      procedure(I_make_extension), deferred :: make_extension
      procedure :: make_extension

      procedure(I_add_to_state), deferred :: add_to_state
      procedure(I_add_to_bundle), deferred :: add_to_bundle
      procedure(I_set_geometry), deferred :: set_geometry

      procedure(I_write_formatted), deferred :: write_formatted
#ifndef __GFORTRAN__
      generic :: write(formatted) => write_formatted
#endif

      procedure, non_overridable :: set_allocated
      procedure, non_overridable :: is_allocated
      procedure, non_overridable :: is_active
      procedure, non_overridable :: set_active
!#      procedure, non_overridable :: get_aspect
!#      procedure, non_overridable :: get_aspects
!#      procedure, non_overridable :: set_aspect
      procedure :: get_aspect
      procedure :: get_aspects
      procedure :: set_aspect

      procedure :: get_dependencies
      procedure :: get_raw_dependencies
      procedure :: set_dependencies
      procedure :: set_raw_dependencies
   end type StateItemSpec