FieldSpec Derived Type

type, public, extends(StateItemSpec) :: FieldSpec


Inherits

type~~fieldspec~2~~InheritsGraph type~fieldspec~2 FieldSpec ESMF_Field ESMF_Field type~fieldspec~2->ESMF_Field payload StringVector StringVector type~fieldspec~2->StringVector attributes type~stateitemspec StateItemSpec type~fieldspec~2->type~stateitemspec 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

Inherited by

type~~fieldspec~2~~InheritedByGraph type~fieldspec~2 FieldSpec type~bracketspec BracketSpec type~bracketspec->type~fieldspec~2 reference_spec, field_specs

Components

Type Visibility Attributes Name Initial
character(len=:), public, allocatable :: long_name
character(len=:), public, allocatable :: standard_name
logical, public :: is_created = .false.
real, public, allocatable :: default_value
type(ESMF_Field), public :: payload
type(StringVector), public :: attributes

Constructor

public interface FieldSpec

  • public function new_FieldSpec_geom(unusable, geom, vertical_grid, vertical_dim_spec, typekind, ungridded_dims, standard_name, long_name, units, attributes, regrid_param, horizontal_dims_spec, default_value, accumulation_type, timestep) result(field_spec)

    Arguments

    Type IntentOptional Attributes Name
    class(KeywordEnforcer), intent(in), optional :: unusable
    type(ESMF_Geom), intent(in), optional :: geom
    class(VerticalGrid), intent(in), optional :: vertical_grid
    type(VerticalDimSpec), intent(in) :: vertical_dim_spec
    type(ESMF_TypeKind_Flag), intent(in) :: typekind
    type(UngriddedDims), intent(in), optional :: ungridded_dims
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: long_name
    character(len=*), intent(in), optional :: units
    type(StringVector), intent(in), optional :: attributes
    type(EsmfRegridderParam), intent(in), optional :: regrid_param
    type(HorizontalDimsSpec), intent(in), optional :: horizontal_dims_spec
    real, intent(in), optional :: default_value
    character(len=*), intent(in), optional :: accumulation_type
    type(ESMF_TimeInterval), intent(in), optional :: timestep

    Return Value type(FieldSpec), target

  • private function new_FieldSpec_varspec(variable_spec) result(field_spec)

    Arguments

    Type IntentOptional Attributes Name
    class(VariableSpec), intent(in) :: variable_spec

    Return Value type(FieldSpec)


Type-Bound Procedures

procedure, public :: add_to_bundle

  • private subroutine add_to_bundle(this, bundle, rc)

    Arguments

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

procedure, public :: add_to_state

  • private subroutine add_to_state(this, multi_state, actual_pt, rc)

    Arguments

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

procedure, public :: allocate

  • private subroutine allocate(this, rc)

    Arguments

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

procedure, public :: can_connect_to

  • private function can_connect_to(this, src_spec, rc)

    Arguments

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

    Return Value logical

procedure, public :: connect_to

  • private subroutine connect_to(this, src_spec, actual_pt, rc)

    Arguments

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

procedure, public :: create

  • private subroutine create(this, rc)

    Arguments

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

procedure, public :: destroy

  • private subroutine destroy(this, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(FieldSpec), 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(FieldSpec), 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_payload

  • private function get_payload(this) result(payload)

    Arguments

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

    Return Value type(ESMF_Field)

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, public :: set_geometry

  • private subroutine set_geometry(this, geom, vertical_grid, timestep, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(FieldSpec), 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, public :: write_formatted

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

    Arguments

    Type IntentOptional Attributes Name
    class(FieldSpec), 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, extends(StateItemSpec) :: FieldSpec

      type(StringVector) :: attributes
!#      type(EsmfRegridderParam) :: regrid_param

      ! Metadata
      character(:), allocatable :: standard_name
      character(:), allocatable :: long_name
      ! TBD
!#      type(FrequencySpec) :: freq_spec
!#      class(AbstractFrequencySpec), allocatable :: freq_spec
!#      integer :: halo_width = 0

      type(ESMF_Field) :: payload
      real, allocatable :: default_value
!#      type(VariableSpec) :: variable_spec

      logical :: is_created = .false.

   contains

      procedure :: create
      procedure :: destroy
      procedure :: allocate
      procedure :: get_payload

      procedure :: connect_to
      procedure :: can_connect_to
      procedure :: add_to_state
      procedure :: add_to_bundle

      procedure :: get_aspect_priorities

      procedure :: set_geometry

      procedure :: write_formatted
   end type FieldSpec