mom_cap_methods::state_getfldptr Interface Reference

Detailed Description

Get field pointer.

Definition at line 36 of file mom_cap_methods.F90.

Private functions
subroutine	state_getfldptr_1d (State, fldname, fldptr, rc)
	Get field pointer 1D. More...
subroutine	state_getfldptr_2d (State, fldname, fldptr, rc)
	Get field pointer 2D. More...

Functions and subroutines

state_getfldptr_1d()

subroutine mom_cap_methods::state_getfldptr::state_getfldptr_1d ( type(esmf_state), intent(in)  State, character(len=*), intent(in)  fldname, real(esmf_kind_r8), dimension(:), intent(in), pointer  fldptr, integer, intent(out), optional  rc  )

private

Get field pointer 1D.

Parameters

[in]	state	ESMF state
[in]	fldname	Field name
[in]	fldptr	Pointer to the 1D field
[out]	rc	Return code

Definition at line 619 of file mom_cap_methods.F90.

  type(ESMF_State)            , intent(in)  :: State    !< ESMF state
  character(len=*)            , intent(in)  :: fldname  !< Field name
  real(ESMF_KIND_R8), pointer , intent(in)  :: fldptr(:)!< Pointer to the 1D field
  integer, optional           , intent(out) :: rc       !< Return code
 
  ! local variables
  type(ESMF_Field) :: lfield
  integer :: lrc
  character(len=*),parameter :: subname='(MOM_cap:State_GetFldPtr)'
 
  call esmf_stateget(state, itemname=trim(fldname), field=lfield, rc=lrc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
  call esmf_fieldget(lfield, farrayptr=fldptr, rc=lrc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
 
  if (present(rc)) rc = lrc
 

state_getfldptr_2d()

subroutine mom_cap_methods::state_getfldptr::state_getfldptr_2d ( type(esmf_state), intent(in)  State, character(len=*), intent(in)  fldname, real(esmf_kind_r8), dimension(:,:), intent(in), pointer  fldptr, integer, intent(out), optional  rc  )

private

Get field pointer 2D.

Parameters

[in]	state	ESMF state
[in]	fldname	Field name
[in]	fldptr	Pointer to the 2D field
[out]	rc	Return code

Definition at line 646 of file mom_cap_methods.F90.

  type(ESMF_State)            , intent(in)  :: State      !< ESMF state
  character(len=*)            , intent(in)  :: fldname    !< Field name
  real(ESMF_KIND_R8), pointer , intent(in)  :: fldptr(:,:)!< Pointer to the 2D field
  integer, optional           , intent(out) :: rc         !< Return code
 
  ! local variables
  type(ESMF_Field) :: lfield
  integer :: lrc
  character(len=*),parameter :: subname='(MOM_cap:State_GetFldPtr)'
 
  call esmf_stateget(state, itemname=trim(fldname), field=lfield, rc=lrc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
  call esmf_fieldget(lfield, farrayptr=fldptr, rc=lrc)
  if (esmf_logfounderror(rctocheck=rc, msg=esmf_logerr_passthru, &
    line=__line__, &
    file=__file__)) &
    return  ! bail out
 
  if (present(rc)) rc = lrc
 

---

The documentation for this interface was generated from the following file:

• /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/config_src/nuopc_driver/mom_cap_methods.F90