ESMF_MeshTurnOnCellMask Subroutine

public subroutine ESMF_MeshTurnOnCellMask(mesh, maskValues, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Mesh), intent(in) :: mesh
integer(kind=ESMF_KIND_I4), optional :: maskValues(:)
integer, intent(out), optional :: rc

Calls

proc~~esmf_meshturnoncellmask~~CallsGraph proc~esmf_meshturnoncellmask ESMF_MeshTurnOnCellMask c_esmc_meshturnoncellmask c_esmc_meshturnoncellmask proc~esmf_meshturnoncellmask->c_esmc_meshturnoncellmask interface~esmf_interarraycreate ESMF_InterArrayCreate proc~esmf_meshturnoncellmask->interface~esmf_interarraycreate proc~esmf_interarraydestroy ESMF_InterArrayDestroy proc~esmf_meshturnoncellmask->proc~esmf_interarraydestroy proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_meshturnoncellmask->proc~esmf_logfounderror proc~esmf_interarraycreateptr ESMF_InterArrayCreatePtr interface~esmf_interarraycreate->proc~esmf_interarraycreateptr proc~esmf_interarraycreatetrg ESMF_InterArrayCreateTrg interface~esmf_interarraycreate->proc~esmf_interarraycreatetrg proc~esmf_logfounddeallocerror ESMF_LogFoundDeallocError proc~esmf_interarraydestroy->proc~esmf_logfounddeallocerror esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite proc~esmf_interarraycreateptr->proc~esmf_logfounderror c_esmc_interarraycreate1d c_esmc_interarraycreate1d proc~esmf_interarraycreateptr->c_esmc_interarraycreate1d c_esmc_interarraycreate1di8 c_esmc_interarraycreate1di8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate1di8 c_esmc_interarraycreate1dr8 c_esmc_interarraycreate1dr8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate1dr8 c_esmc_interarraycreate2d c_esmc_interarraycreate2d proc~esmf_interarraycreateptr->c_esmc_interarraycreate2d c_esmc_interarraycreate2di8 c_esmc_interarraycreate2di8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate2di8 c_esmc_interarraycreate2dr8 c_esmc_interarraycreate2dr8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate2dr8 c_esmc_interarraycreate3d c_esmc_interarraycreate3d proc~esmf_interarraycreateptr->c_esmc_interarraycreate3d c_esmc_interarraycreate3di8 c_esmc_interarraycreate3di8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate3di8 c_esmc_interarraycreate3dr8 c_esmc_interarraycreate3dr8 proc~esmf_interarraycreateptr->c_esmc_interarraycreate3dr8 c_esmc_interarraysetinvalid c_esmc_interarraysetinvalid proc~esmf_interarraycreateptr->c_esmc_interarraysetinvalid proc~esmf_logseterror ESMF_LogSetError proc~esmf_interarraycreateptr->proc~esmf_logseterror proc~esmf_interarraycreatetrg->interface~esmf_interarraycreate proc~esmf_interarraycreatetrg->proc~esmf_logfounderror proc~esmf_interarraycreatetrg->c_esmc_interarraysetinvalid proc~esmf_logfounddeallocerror->esmf_breakpoint proc~esmf_logfounddeallocerror->proc~esmf_logrc2msg proc~esmf_logfounddeallocerror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget proc~esmf_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->proc~esmf_logwrite

Called by

proc~~esmf_meshturnoncellmask~~CalledByGraph proc~esmf_meshturnoncellmask ESMF_MeshTurnOnCellMask proc~conserve_gridtomesh conserve_GridToMesh proc~conserve_gridtomesh->proc~esmf_meshturnoncellmask proc~esmf_xgridcreate ESMF_XGridCreate proc~esmf_xgridcreate->proc~esmf_meshturnoncellmask proc~getmeshoncornerswfieldoncenter getMeshOnCornersWFieldOnCenter proc~getmeshoncornerswfieldoncenter->proc~esmf_meshturnoncellmask proc~getmeshoncornerswfieldoncenter->proc~conserve_gridtomesh proc~esmf_fieldregridstorenx ESMF_FieldRegridStoreNX proc~esmf_fieldregridstorenx->proc~getmeshoncornerswfieldoncenter proc~esmf_fieldregridstorex ESMF_FieldRegridStoreX proc~esmf_fieldregridstorex->proc~conserve_gridtomesh proc~f_esmf_xgridcreate f_esmf_xgridcreate proc~f_esmf_xgridcreate->proc~esmf_xgridcreate proc~test2d_masking_single test2d_masking_single proc~test2d_masking_single->proc~esmf_xgridcreate proc~test3d_masking_global test3d_masking_global proc~test3d_masking_global->proc~esmf_xgridcreate proc~test3d_masking_regional test3d_masking_regional proc~test3d_masking_regional->proc~esmf_xgridcreate proc~test4 test4 proc~test4->proc~esmf_xgridcreate proc~test5 test5 proc~test5->proc~esmf_xgridcreate proc~test6 test6 proc~test6->proc~esmf_xgridcreate proc~test7 test7 proc~test7->proc~esmf_xgridcreate proc~test8 test8 proc~test8->proc~esmf_xgridcreate proc~test_cart_bilinear_xgrid test_cart_bilinear_xgrid proc~test_cart_bilinear_xgrid->proc~esmf_xgridcreate proc~test_cartmeshtomesh_2nd test_CartMeshToMesh_2nd proc~test_cartmeshtomesh_2nd->proc~esmf_xgridcreate proc~test_csgridtogrid_2nd test_CSGridToGrid_2nd proc~test_csgridtogrid_2nd->proc~esmf_xgridcreate proc~test_meshtomesh_2nd test_MeshToMesh_2nd proc~test_meshtomesh_2nd->proc~esmf_xgridcreate proc~test_regrid2xg_online test_regrid2xg_online proc~test_regrid2xg_online->proc~esmf_xgridcreate proc~test_regrid2xgsph~2 test_regrid2xgSph proc~test_regrid2xgsph~2->proc~esmf_xgridcreate proc~test_side_and_elem_info test_side_and_elem_info proc~test_side_and_elem_info->proc~esmf_xgridcreate proc~test_sph_bilinear_xgrid test_sph_bilinear_xgrid proc~test_sph_bilinear_xgrid->proc~esmf_xgridcreate proc~test_xgrid_w_ngon_mesh test_xgrid_w_ngon_mesh proc~test_xgrid_w_ngon_mesh->proc~esmf_xgridcreate proc~user_init~7 user_init proc~user_init~7->proc~esmf_xgridcreate proc~user_init~9 user_init proc~user_init~9->proc~esmf_xgridcreate program~esmf_xgridex ESMF_XGridEx program~esmf_xgridex->proc~esmf_xgridcreate program~esmf_xgridutest ESMF_XGridUTest program~esmf_xgridutest->proc~esmf_xgridcreate program~esmf_xgridutest->proc~test4 program~esmf_xgridutest->proc~test5 program~esmf_xgridutest->proc~test6 program~esmf_xgridutest->proc~test7 program~esmf_xgridutest->proc~test8 program~esmf_xgridutest->proc~test_cartmeshtomesh_2nd program~esmf_xgridutest->proc~test_csgridtogrid_2nd program~esmf_xgridutest->proc~test_meshtomesh_2nd program~esmf_xgridutest->proc~test_side_and_elem_info program~esmf_xgridutest->proc~test_xgrid_w_ngon_mesh interface~esmf_fieldregridstore ESMF_FieldRegridStore interface~esmf_fieldregridstore->proc~esmf_fieldregridstorenx interface~esmf_fieldregridstore->proc~esmf_fieldregridstorex program~esmf_xgridmaskingutest ESMF_XGridMaskingUTest program~esmf_xgridmaskingutest->proc~test2d_masking_single program~esmf_xgridmaskingutest->proc~test3d_masking_global program~esmf_xgridmaskingutest->proc~test3d_masking_regional

Source Code

   subroutine ESMF_MeshTurnOnCellMask(mesh, maskValues, rc)
!
! !ARGUMENTS:
    type(ESMF_Mesh), intent(in)                :: mesh
    integer(ESMF_KIND_I4), optional            :: maskValues(:)
    integer, intent(out) , optional            :: rc
!
! !DESCRIPTION:
!   Turn on mesh masking
!
!   \begin{description}
!   \item [mesh]
!         The mesh to turn on masking for
!   \item [maskValues]
!         Values to set as masked
!   \item [{[rc]}]
!         Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!   \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer :: localrc
    type(ESMF_InterArray) :: maskValuesArg

    ! Init localrc
    localrc = ESMF_SUCCESS

    ! If not present, then don't need to turn anything on
    if (.not. present(maskValues)) then
       if (present(rc)) rc = ESMF_SUCCESS
       return
    endif

    ! convert mask values
    maskValuesArg = ESMF_InterArrayCreate(maskValues, rc=localrc)
        if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
          ESMF_CONTEXT, rcToReturn=rc)) return

    call c_esmc_meshturnoncellmask(mesh, maskValuesArg, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return

    call ESMF_InterArrayDestroy(maskValuesArg, rc=localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
            ESMF_CONTEXT, rcToReturn=rc)) return

    if (present(rc)) rc = ESMF_SUCCESS

    end subroutine ESMF_MeshTurnOnCellMask