ExternalGridFactory Derived Type

type, public, extends(AbstractGridFactory) :: ExternalGridFactory


Inherits

type~~externalgridfactory~~InheritsGraph type~externalgridfactory ExternalGridFactory ESMF_Grid ESMF_Grid type~externalgridfactory->ESMF_Grid external_grid type~abstractgridfactory AbstractGridFactory type~externalgridfactory->type~abstractgridfactory type~abstractgridfactory->ESMF_Grid grid

Components

Type Visibility Attributes Name Initial
character(len=:), public, allocatable :: grid_name
integer, public, allocatable :: lm
type(ESMF_Grid), public, allocatable :: external_grid

Constructor

public interface ExternalGridFactory

  • private function ExternalGridFactory_from_parameters(unusable, grid_name, grid, lm, rc) result(factory)

    Arguments

    Type IntentOptional Attributes Name
    class(KeywordEnforcer), intent(in), optional :: unusable
    character(len=*), intent(in), optional :: grid_name
    type(ESMF_Grid), intent(in), optional :: grid
    integer, intent(in), optional :: lm
    integer, intent(out), optional :: rc

    Return Value type(ExternalGridFactory)


Type-Bound Procedures

procedure, public :: append_metadata

  • private subroutine append_metadata(this, metadata)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(FileMetadata), intent(inout) :: metadata

procedure, public :: append_variable_metadata

  • private subroutine append_variable_metadata(this, var)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(Variable), intent(inout) :: var

generic, public :: cartesian_to_spherical => cartesian_to_spherical_2d_real32

  • private subroutine cartesian_to_spherical_2d_real32(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL32), intent(out) :: u(:,:)
    real(kind=REAL32), intent(out) :: v(:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: cartesian_to_spherical => cartesian_to_spherical_2d_real64

  • private subroutine cartesian_to_spherical_2d_real64(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL64), intent(out) :: u(:,:)
    real(kind=REAL64), intent(out) :: v(:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: cartesian_to_spherical => cartesian_to_spherical_3d_real32

  • private subroutine cartesian_to_spherical_3d_real32(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL32), intent(out) :: u(:,:,:)
    real(kind=REAL32), intent(out) :: v(:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: cartesian_to_spherical => cartesian_to_spherical_3d_real64

  • private subroutine cartesian_to_spherical_3d_real64(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL64), intent(out) :: u(:,:,:)
    real(kind=REAL64), intent(out) :: v(:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: cartesian_to_spherical_2d_real32

  • private subroutine cartesian_to_spherical_2d_real32(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL32), intent(out) :: u(:,:)
    real(kind=REAL32), intent(out) :: v(:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: cartesian_to_spherical_2d_real64

  • private subroutine cartesian_to_spherical_2d_real64(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL64), intent(out) :: u(:,:)
    real(kind=REAL64), intent(out) :: v(:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: cartesian_to_spherical_3d_real32

  • private subroutine cartesian_to_spherical_3d_real32(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL32), intent(out) :: u(:,:,:)
    real(kind=REAL32), intent(out) :: v(:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: cartesian_to_spherical_3d_real64

  • private subroutine cartesian_to_spherical_3d_real64(this, xyz, u, v, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: xyz(:,:,:,:)
    real(kind=REAL64), intent(out) :: u(:,:,:)
    real(kind=REAL64), intent(out) :: v(:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: clone

procedure, public :: decomps_are_equal

  • private function decomps_are_equal(this, a) result(equal)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(in) :: this
    class(AbstractGridFactory), intent(in) :: a

    Return Value logical

procedure, public :: destroy

  • private subroutine destroy(this, rc)

    Arguments

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

procedure, public :: equals

procedure, public :: generate_file_bounds

  • private subroutine generate_file_bounds(this, grid, local_start, global_start, global_count, metaData, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(ESMF_Grid), intent(inout) :: grid
    integer, intent(out), allocatable :: local_start(:)
    integer, intent(out), allocatable :: global_start(:)
    integer, intent(out), allocatable :: global_count(:)
    type(FileMetadata), intent(in), optional :: metaData
    integer, intent(out), optional :: rc

procedure, public :: generate_file_corner_bounds

  • private subroutine generate_file_corner_bounds(this, grid, local_start, global_start, global_count, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(ESMF_Grid), intent(inout) :: grid
    integer, intent(out), allocatable :: local_start(:)
    integer, intent(out), allocatable :: global_start(:)
    integer, intent(out), allocatable :: global_count(:)
    integer, intent(out), optional :: rc

procedure, public :: generate_file_reference2D

  • private function generate_file_reference2D(this, fpointer) result(ref)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    real, intent(in), pointer :: fpointer(:,:)

    Return Value type(ArrayReference)

procedure, public :: generate_file_reference3D

  • private function generate_file_reference3D(this, fpointer, metaData) result(ref)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    real, intent(in), pointer :: fpointer(:,:,:)
    type(FileMetadata), intent(in), optional :: metaData

    Return Value type(ArrayReference)

procedure, public :: generate_grid_name

  • private function generate_grid_name(this) result(name)

    Arguments

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

    Return Value character(len=:), allocatable

procedure, public :: get_basis

  • private function get_basis(this, basis, unusable, rc) result(basis_vectors)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

    Return Value real(kind=REAL64), pointer, (:,:,:,:)

procedure, public :: get_file_format_vars

  • private function get_file_format_vars(this) result(vars)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this

    Return Value character(len=:), allocatable

procedure, public :: get_grid

  • private function get_grid(this, unusable, rc) result(grid)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), target :: this
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

    Return Value type(ESMF_Grid), pointer

procedure, public :: get_grid_vars

  • private function get_grid_vars(this) result(vars)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this

    Return Value character(len=:), allocatable

procedure, public :: get_obs_time

  • private subroutine get_obs_time(this, grid, obs_time, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout) :: this
    type(ESMF_Grid), intent(in) :: grid
    real(kind=ESMF_KIND_R4), intent(out) :: obs_time(:,:)
    integer, intent(out), optional :: rc

procedure, public :: get_xy_mask

  • private subroutine get_xy_mask(this, interval, xy_mask, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout) :: this
    type(ESMF_Time), intent(in) :: interval(2)
    integer, intent(out), allocatable :: xy_mask(:,:)
    integer, intent(out), optional :: rc

procedure, public :: get_xy_subset

  • private subroutine get_xy_subset(this, interval, xy_subset, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(in) :: this
    type(ESMF_Time), intent(in) :: interval(2)
    integer, intent(out) :: xy_subset(2,2)
    integer, intent(out), optional :: rc

procedure, public :: halo

  • private subroutine halo(this, array, unusable, halo_width, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    real(kind=REAL32), intent(inout) :: array(:,:)
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(in), optional :: halo_width
    integer, intent(out), optional :: rc

generic, public :: initialize => initialize_from_config

  • private subroutine initialize_from_config(this, config, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout) :: this
    type(ESMF_Config), intent(inout) :: config
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: initialize => initialize_from_file_metadata

  • private subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_file_coordinates, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(XYGridFactory), intent(inout) :: this
    type(FileMetadata), intent(in), target :: file_metadata
    class(KeywordEnforcer), intent(in), optional :: unusable
    logical, intent(in), optional :: force_file_coordinates
    integer, intent(out), optional :: rc

generic, public :: initialize => initialize_from_config_with_prefix

  • private subroutine initialize_from_config_with_prefix(this, config, prefix, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(XYGridFactory), intent(inout) :: this
    type(ESMF_Config), intent(inout) :: config
    character(len=*), intent(in) :: prefix
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: initialize => initialize_from_esmf_distGrid

  • private subroutine initialize_from_esmf_distGrid(this, dist_grid, lon_array, lat_array, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(XYGridFactory), intent(inout) :: this
    type(ESMF_DistGrid), intent(in) :: dist_grid
    type(ESMF_LocalArray), intent(in) :: lon_array
    type(ESMF_LocalArray), intent(in) :: lat_array
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: initialize_from_config

  • private subroutine initialize_from_config(this, config, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout) :: this
    type(ESMF_Config), intent(inout) :: config
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: initialize_from_config_with_prefix

  • private subroutine initialize_from_config_with_prefix(this, config, prefix, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(ESMF_Config), intent(inout) :: config
    character(len=*), intent(in) :: prefix
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: initialize_from_esmf_distGrid

  • private subroutine initialize_from_esmf_distGrid(this, dist_grid, lon_array, lat_array, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(ESMF_DistGrid), intent(in) :: dist_grid
    type(ESMF_LocalArray), intent(in) :: lon_array
    type(ESMF_LocalArray), intent(in) :: lat_array
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: initialize_from_file_metadata

  • private subroutine initialize_from_file_metadata(this, file_metadata, unusable, force_file_coordinates, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(inout) :: this
    type(FileMetadata), intent(in), target :: file_metadata
    class(KeywordEnforcer), intent(in), optional :: unusable
    logical, intent(in), optional :: force_file_coordinates
    integer, intent(out), optional :: rc

procedure, public, nopass :: make_arbitrary_decomposition

  • private subroutine make_arbitrary_decomposition(nx, ny, unusable, reduceFactor, rc)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(out) :: nx
    integer, intent(out) :: ny
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(in), optional :: reduceFactor
    integer, intent(out), optional :: rc

procedure, public :: make_grid

  • private function make_grid(this, unusable, rc) result(grid)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout) :: this
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

    Return Value type(ESMF_Grid)

procedure, public :: make_new_grid

  • private function make_new_grid(this, unusable, rc) result(grid)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(in) :: this
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

    Return Value type(ESMF_Grid)

generic, public :: operator(==) => equals

  • private function equals(a, b)

    Arguments

    Type IntentOptional Attributes Name
    class(XYGridFactory), intent(in) :: a
    class(AbstractGridFactory), intent(in) :: b

    Return Value logical

procedure, public :: physical_params_are_equal

  • private function physical_params_are_equal(this, a) result(equal)

    Arguments

    Type IntentOptional Attributes Name
    class(ExternalGridFactory), intent(in) :: this
    class(AbstractGridFactory), intent(in) :: a

    Return Value logical

generic, public :: spherical_to_cartesian => spherical_to_cartesian_2d_real32

  • private subroutine spherical_to_cartesian_2d_real32(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: u(:,:)
    real(kind=REAL32), intent(in) :: v(:,:)
    real(kind=REAL32), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: spherical_to_cartesian => spherical_to_cartesian_2d_real64

  • private subroutine spherical_to_cartesian_2d_real64(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: u(:,:)
    real(kind=REAL64), intent(in) :: v(:,:)
    real(kind=REAL64), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: spherical_to_cartesian => spherical_to_cartesian_3d_real32

  • private subroutine spherical_to_cartesian_3d_real32(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: u(:,:,:)
    real(kind=REAL32), intent(in) :: v(:,:,:)
    real(kind=REAL32), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

generic, public :: spherical_to_cartesian => spherical_to_cartesian_3d_real64

  • private subroutine spherical_to_cartesian_3d_real64(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: u(:,:,:)
    real(kind=REAL64), intent(in) :: v(:,:,:)
    real(kind=REAL64), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: spherical_to_cartesian_2d_real32

  • private subroutine spherical_to_cartesian_2d_real32(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: u(:,:)
    real(kind=REAL32), intent(in) :: v(:,:)
    real(kind=REAL32), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: spherical_to_cartesian_2d_real64

  • private subroutine spherical_to_cartesian_2d_real64(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: u(:,:)
    real(kind=REAL64), intent(in) :: v(:,:)
    real(kind=REAL64), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: spherical_to_cartesian_3d_real32

  • private subroutine spherical_to_cartesian_3d_real32(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL32), intent(in) :: u(:,:,:)
    real(kind=REAL32), intent(in) :: v(:,:,:)
    real(kind=REAL32), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: spherical_to_cartesian_3d_real64

  • private subroutine spherical_to_cartesian_3d_real64(this, u, v, xyz, basis, unusable, rc)

    Arguments

    Type IntentOptional Attributes Name
    class(AbstractGridFactory), intent(inout), target :: this
    real(kind=REAL64), intent(in) :: u(:,:,:)
    real(kind=REAL64), intent(in) :: v(:,:,:)
    real(kind=REAL64), intent(out) :: xyz(:,:,:,:)
    character(len=*), intent(in) :: basis
    class(KeywordEnforcer), intent(in), optional :: unusable
    integer, intent(out), optional :: rc

procedure, public :: to_string

  • private function to_string(this) result(string)

    Arguments

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

    Return Value character(len=:), allocatable

Source Code

   type, extends(AbstractGridFactory) :: ExternalGridFactory
      character(len=:), allocatable :: grid_name
      type(ESMF_Grid),  allocatable :: external_grid
      integer,          allocatable :: lm
   contains
      procedure :: make_new_grid

      procedure :: equals

      procedure :: initialize_from_file_metadata
      procedure :: initialize_from_config_with_prefix
      procedure :: initialize_from_esmf_distGrid

      procedure :: halo

      procedure :: generate_grid_name

      procedure :: append_metadata
      procedure :: get_grid_vars
      procedure :: get_file_format_vars
      procedure :: append_variable_metadata
      procedure :: generate_file_bounds
      procedure :: generate_file_corner_bounds
      procedure :: generate_file_reference2D
      procedure :: generate_file_reference3D
      procedure :: decomps_are_equal
      procedure :: physical_params_are_equal
   end type ExternalGridFactory