monc_component.F90

Go to the documentation of this file.

module monc_component_mod
    use state_mod, only : model_state_type
    use datadefn_mod, only : default_precision, string_length
    implicit none

#ifndef TEST_MODE
    private
#endif

    integer, parameter :: component_scalar_field_type = 1, component_array_field_type=2
    integer, parameter :: component_integer_data_type = 1, component_double_data_type=5

    integer, public, parameter :: init_priority_index=1, timestep_priority_index=2, finalisation_priority_index=5 

    type, public :: component_field_value_type
       real(kind=DEFAULT_PRECISION), dimension(:,:,:,:), allocatable :: real_4d_array
       real(kind=DEFAULT_PRECISION), dimension(:,:,:), allocatable :: real_3d_array
       real(kind=DEFAULT_PRECISION), dimension(:,:), allocatable :: real_2d_array
       real(kind=DEFAULT_PRECISION), dimension(:), allocatable :: real_1d_array
       real(kind=DEFAULT_PRECISION) :: scalar_real
       integer :: scalar_int
    end type component_field_value_type

    type, public :: component_field_information_type
       integer :: field_type, data_type, number_dimensions, dimension_sizes(4)
       logical :: enabled
    end type component_field_information_type

    type, public :: component_descriptor_type
      procedure(component_initialisation), nopass, pointer :: initialisation => null()  
      procedure(component_timestep), nopass, pointer :: timestep => null()              
      procedure(component_finalisation), nopass, pointer :: finalisation => null()      
      procedure(component_get_field_value), nopass, pointer :: field_value_retrieval => null()
      procedure(component_get_field_information), nopass, pointer :: field_information_retrieval => null()
      character(len=STRING_LENGTH), dimension(:), pointer :: published_fields => null()
      character(len=STRING_LENGTH) :: name
      real(kind=DEFAULT_PRECISION) :: version
    end type component_descriptor_type

    abstract interface
      function component_get_description()
        import :: component_descriptor_type
        type(component_descriptor_type) :: component_get_description
      end function component_get_description
      subroutine component_initialisation(current_state)
        import :: model_state_type
        type(model_state_type), target, intent(inout) :: current_state
      end subroutine component_initialisation

      subroutine component_timestep(current_state)
        import :: model_state_type
        type(model_state_type), target, intent(inout) :: current_state
      end subroutine component_timestep

      subroutine component_finalisation(current_state)
        import :: model_state_type
        type(model_state_type), target, intent(inout) :: current_state
      end subroutine component_finalisation

      subroutine component_get_field_information(current_state, name, field_sizing)
        import :: component_field_information_type, model_state_type
        type(model_state_type), target, intent(inout) :: current_state
        character(len=*), intent(in) :: name
        type(component_field_information_type), intent(out) :: field_sizing
      end subroutine component_get_field_information      

      subroutine component_get_field_value(current_state, name, field_value)
        import :: component_field_value_type, model_state_type
        type(model_state_type), target, intent(inout) :: current_state
        character(len=*), intent(in) :: name
        type(component_field_value_type), intent(out) :: field_value
      end subroutine component_get_field_value      
    end interface

    public component_scalar_field_type, component_array_field_type, component_integer_data_type, component_double_data_type, &
         component_initialisation, component_timestep, component_finalisation, component_get_description
end module monc_component_mod