BinIOMod Module

MODULE: BinIO

Author: GMAO SI-Team

BinIO - A Module to do I/O (ASCII+binary) until ESMF fully supports it


Uses

  • module~~biniomod~~UsesGraph module~biniomod BinIOMod ESMF ESMF module~biniomod->ESMF iso_c_binding iso_c_binding module~biniomod->iso_c_binding iso_fortran_env iso_fortran_env module~biniomod->iso_fortran_env module~fileiosharedmod FileIOSharedMod module~biniomod->module~fileiosharedmod module~mapl_basemod MAPL_BaseMod module~biniomod->module~mapl_basemod module~mapl_commsmod MAPL_CommsMod module~biniomod->module~mapl_commsmod module~mapl_exceptionhandling MAPL_ExceptionHandling module~biniomod->module~mapl_exceptionhandling module~mapl_shmemmod MAPL_ShmemMod module~biniomod->module~mapl_shmemmod module~mapl_sortmod MAPL_SortMod module~biniomod->module~mapl_sortmod mpi mpi module~biniomod->mpi module~fileiosharedmod->ESMF module~fileiosharedmod->iso_c_binding module~fileiosharedmod->iso_fortran_env module~fileiosharedmod->module~mapl_basemod module~fileiosharedmod->module~mapl_commsmod module~fileiosharedmod->module~mapl_exceptionhandling module~fileiosharedmod->module~mapl_shmemmod module~fileiosharedmod->module~mapl_sortmod module~fileiosharedmod->mpi module~mapl_base MAPL_Base module~mapl_basemod->module~mapl_base module~mapl_constants MAPL_Constants module~mapl_basemod->module~mapl_constants module~mapl_maplgrid mapl_MaplGrid module~mapl_basemod->module~mapl_maplgrid module~mapl_rangemod MAPL_RangeMod module~mapl_basemod->module~mapl_rangemod module~mapl_commsmod->ESMF module~mapl_commsmod->module~mapl_basemod module~mapl_commsmod->module~mapl_exceptionhandling module~mapl_commsmod->module~mapl_shmemmod module~mapl_commsmod->mpi module~mapl_commsmod->module~mapl_constants module~mapl_errorhandlingmod MAPL_ErrorHandlingMod module~mapl_exceptionhandling->module~mapl_errorhandlingmod module~mapl_throwmod MAPL_ThrowMod module~mapl_exceptionhandling->module~mapl_throwmod module~mapl_shmem MAPL_Shmem module~mapl_shmemmod->module~mapl_shmem module~mapl_sortmod->iso_fortran_env module~mapl_sortmod->module~mapl_exceptionhandling module~mapl_base->ESMF module~mapl_base->iso_fortran_env module~mapl_constants->iso_fortran_env module~mapl_internalconstantsmod MAPL_InternalConstantsMod module~mapl_constants->module~mapl_internalconstantsmod module~mapl_mathconstantsmod MAPL_MathConstantsMod module~mapl_constants->module~mapl_mathconstantsmod module~mapl_physicalconstantsmod MAPL_PhysicalConstantsMod module~mapl_constants->module~mapl_physicalconstantsmod module~mapl_errorhandlingmod->mpi module~mapl_errorhandlingmod->module~mapl_throwmod module~mapl_maplgrid->ESMF module~mapl_maplgrid->module~mapl_errorhandlingmod module~mapl_constantsmod MAPL_ConstantsMod module~mapl_maplgrid->module~mapl_constantsmod module~mapl_keywordenforcermod MAPL_KeywordEnforcerMod module~mapl_maplgrid->module~mapl_keywordenforcermod module~pflogger pflogger module~mapl_maplgrid->module~pflogger module~mapl_rangemod->iso_fortran_env module~mapl_rangemod->module~mapl_exceptionhandling module~mapl_shmem->iso_c_binding module~mapl_shmem->iso_fortran_env module~mapl_shmem->mpi module~mapl_shmem->module~mapl_constants module~mapl_constantsmod->module~mapl_constants module~mapl_internalconstantsmod->iso_fortran_env module~mapl_mathconstantsmod->iso_fortran_env module~mapl_physicalconstantsmod->iso_fortran_env module~mapl_physicalconstantsmod->module~mapl_mathconstantsmod module~pfl_keywordenforcermod PFL_KeywordEnforcerMod module~pflogger->module~pfl_keywordenforcermod module~pfl_logger PFL_Logger module~pflogger->module~pfl_logger module~pfl_loggermanager PFL_LoggerManager module~pflogger->module~pfl_loggermanager module~pfl_severitylevels PFL_SeverityLevels module~pflogger->module~pfl_severitylevels module~pfl_wraparray PFL_WrapArray module~pflogger->module~pfl_wraparray

Used by

  • module~~biniomod~~UsedByGraph module~biniomod BinIOMod module~mapl_iomod MAPL_IOMod module~mapl_iomod->module~biniomod module~mapl_capgridcompmod MAPL_CapGridCompMod module~mapl_capgridcompmod->module~mapl_iomod module~mapl_cfiomod MAPL_CFIOMod module~mapl_cfiomod->module~mapl_iomod module~mapl_extdatagridcompmod MAPL_ExtDataGridCompMod module~mapl_extdatagridcompmod->module~mapl_iomod module~mapl_genericcplcompmod MAPL_GenericCplCompMod module~mapl_genericcplcompmod->module~mapl_iomod module~mapl_genericmod MAPL_GenericMod module~mapl_genericmod->module~mapl_iomod module~mapl_historygridcompmod MAPL_HistoryGridCompMod module~mapl_historygridcompmod->module~mapl_iomod module~mapl_locstreammod MAPL_LocStreamMod module~mapl_locstreammod->module~mapl_iomod module~mapl_memutilsmod MAPL_MemUtilsMod module~mapl_memutilsmod->module~mapl_iomod module~mapl_sunmod MAPL_SunMod module~mapl_sunmod->module~mapl_iomod module~maplbase_mod MAPLBase_Mod module~maplbase_mod->module~mapl_iomod

Interfaces

public interface MAPL_MemFileInquire

  • private function INQFILEMEM(Name)

    Arguments

    Type IntentOptional Attributes Name
    character(len=*), intent(in) :: Name

    Return Value logical

public interface MAPL_VarRead

  • private subroutine MAPL_StateVarRead(UNIT, STATE, NAME, ARRDES, bootstrapable, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_State), intent(inout) :: STATE
    character(len=*), intent(in), optional :: NAME
    type(ArrDescr), intent(inout), optional :: ARRDES
    logical, intent(in), optional :: bootstrapable
    integer, intent(out), optional :: RC

  • private subroutine MAPL_BundleRead(UNIT, BUNDLE, ARRDES, BOOTSTRAPABLE, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_FieldBundle), intent(inout) :: BUNDLE
    type(ArrDescr), intent(inout), optional :: ARRDES
    logical, intent(in), optional :: BOOTSTRAPABLE
    integer, intent(out), optional :: RC

  • private subroutine MAPL_FieldRead(UNIT, field, ARRDES, HomePE, ignoreEOF, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Field), intent(inout) :: field
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(in), optional, target :: HomePE(:)
    logical, intent(in), optional :: ignoreEOF
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R4_1d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(out) :: A(:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R4_2d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(out) :: A(:,:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R4_3d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(out) :: A(:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R4_4d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(out) :: A(:,:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R8_1d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(out) :: A(:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R8_2d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(out) :: A(:,:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R8_3d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(out) :: A(:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarRead_R8_4d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(out) :: A(:,:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

public interface MAPL_VarWrite

  • private subroutine MAPL_StateVarWrite(UNIT, STATE, NAME, ARRDES, forceWriteNoRestart, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_State), intent(inout) :: STATE
    character(len=*), intent(in), optional :: NAME
    type(ArrDescr), intent(inout), optional :: ARRDES
    logical, intent(in), optional :: forceWriteNoRestart
    integer, intent(out), optional :: RC

  • private subroutine MAPL_BundleWrite(UNIT, BUNDLE, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_FieldBundle), intent(inout) :: BUNDLE
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_FieldWrite(UNIT, field, ARRDES, HomePE, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Field), intent(inout) :: field
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(in), optional, target :: HomePE(:)
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_I4_1d(UNIT, GRID, A, MASK, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    integer(kind=ESMF_KIND_I4), intent(in) :: A(:)
    integer, intent(in), optional :: MASK(:)
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R4_1d(UNIT, GRID, A, MASK, ARRDES, writeFCtrl, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(in) :: A(:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    logical, intent(in), optional :: writeFCtrl
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R4_2d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(in) :: A(:,:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R4_3d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(in) :: A(:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R4_4d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R4), intent(in) :: A(:,:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R8_1d(UNIT, GRID, A, MASK, ARRDES, writeFCtrl, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(in) :: A(:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    logical, intent(in), optional :: writeFCtrl
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R8_2d(UNIT, GRID, A, MASK, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(in) :: A(:,:)
    integer, intent(in), optional :: MASK(:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R8_3d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(in) :: A(:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine MAPL_VarWrite_R8_4d(UNIT, GRID, A, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    integer, intent(in) :: UNIT
    type(ESMF_Grid), intent(inout) :: GRID
    real(kind=ESMF_KIND_R8), intent(in) :: A(:,:,:,:)
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

public interface READ_PARALLEL

  • private subroutine READ_PARALLEL_STRING_0(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    character(len=*), intent(out) :: data
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_I4_0(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    integer(kind=ESMF_KIND_I4), intent(out) :: data
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_I4_1(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    integer(kind=ESMF_KIND_I4), intent(out) :: data(:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_I4_2(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    integer(kind=ESMF_KIND_I4), intent(out) :: data(:,:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R4_0(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R4), intent(out) :: data
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R4_1(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R4), intent(out) :: data(:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R4_2(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R4), intent(out) :: data(:,:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R8_0(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R8), intent(out) :: data
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R8_1(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R8), intent(out) :: data(:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

  • private subroutine READ_PARALLEL_R8_2(layout, data, UNIT, FORMAT, ARRDES, RC)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_DELayout) :: layout
    real(kind=ESMF_KIND_R8), intent(out) :: data(:,:)
    integer, intent(in), optional :: UNIT
    character(len=*), intent(in), optional :: FORMAT
    type(ArrDescr), intent(inout), optional :: ARRDES
    integer, intent(out), optional :: RC

Functions

public function GETFILE(Name, DO_OPEN, Form, ALL_PES, BLOCKSIZE, NUMBUFFERS, RC)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: Name
integer, intent(in), optional :: DO_OPEN
character(len=*), intent(in), optional :: Form
logical, intent(in), optional :: ALL_PES
integer, intent(in), optional :: BLOCKSIZE
integer, intent(in), optional :: NUMBUFFERS
integer, intent(out), optional :: RC

Return Value integer

public function GETFILEUNIT(Name, RC)

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: Name
integer, intent(out), optional :: RC

Return Value integer


Subroutines

public subroutine FREE_FILE(UNIT, RC)

Arguments

Type IntentOptional Attributes Name
integer :: UNIT
integer, intent(out), optional :: RC

public subroutine MAPL_Backspace(UNIT, LAYOUT, COUNT, RC)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: UNIT
type(ESMF_DELayout), intent(in) :: LAYOUT
integer, intent(in), optional :: COUNT
integer, intent(out), optional :: RC

public subroutine MAPL_ClimUpdate(STATE, BEFORE, AFTER, CURRENT_TIME, NAMES, FILE, RC)

Arguments

Type IntentOptional Attributes Name
type(ESMF_State), intent(inout) :: STATE
type(ESMF_Time), intent(out) :: BEFORE
type(ESMF_Time), intent(out) :: AFTER
type(ESMF_Time), intent(inout) :: CURRENT_TIME
character(len=*), intent(in) :: NAMES(:)
character(len=*), intent(in) :: FILE
integer, intent(out), optional :: RC

public subroutine MAPL_DestroyFile(unit, RC)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: unit
integer, intent(out), optional :: RC

public subroutine MAPL_Rewind(UNIT, LAYOUT, RC)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: UNIT
type(ESMF_DELayout), intent(in) :: LAYOUT
integer, intent(out), optional :: RC

public subroutine MAPL_Skip(UNIT, LAYOUT, COUNT, RC)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: UNIT
type(ESMF_DELayout), intent(in) :: LAYOUT
integer, intent(in), optional :: COUNT
integer, intent(out), optional :: RC