hycom Module Reference

Data Types
type	internalstate
type	internalstatestruct

Public Member Functions
subroutine, public	setservices (gcomp, rc)
	NUOPC SetService method is the only public entry point. SetServices registers all of the user-provided subroutines in the module with the NUOPC layer. More...

Private Member Functions
subroutine	initializep0 (gcomp, importState, exportState, clock, rc)
	First initialize subroutine called by NUOPC. The purpose is to set which version of the Initialize Phase Definition (IPD) to use. More...
subroutine	initializeadvertise (gcomp, importState, exportState, clock, rc)
	Called by NUOPC to advertise import and export fields. "Advertise" simply means that the standard names of all import and export fields are supplied. The NUOPC layer uses these to match fields between components in the coupled system. More...
subroutine	initializerealize (gcomp, importState, exportState, clock, rc)
	Called by NUOPC to realize import and export fields. "Realizing" a field means that its grid has been defined and an ESMF_Field object has been created and put into the import or export State. More...
subroutine	modeladvance (gcomp, rc)
	Called by NUOPC to advance the CICE model a single timestep. More...
subroutine	hycom_modeladvance (gcomp, rc)
subroutine	finalize (gcomp, importState, exportState, clock, rc)
	Called by NUOPC at the end of the run to clean up. More...

Private Attributes
logical	restart = .false.
logical	atm_init = .true.
logical	regional = .false.
logical	write_diagnostics = .false.

Member Function/Subroutine Documentation

subroutine hycom::finalize ( type(esmf_gridcomp)  gcomp, type(esmf_state)  importState, type(esmf_state)  exportState, type(esmf_clock)  clock, integer, intent(out)  rc  )

private

Called by NUOPC at the end of the run to clean up.

Parameters

gcomp	an ESMF_GridComp object
importState	an ESMF_State object for import fields
exportState	an ESMF_State object for export fields
clock	an ESMF_Clock object
rc	return code

subroutine hycom::hycom_modeladvance ( type(esmf_gridcomp)  gcomp, integer, intent(out)  rc  )

private

subroutine hycom::initializeadvertise ( type(esmf_gridcomp)  gcomp, type(esmf_state)  importState, type(esmf_state)  exportState, type(esmf_clock)  clock, integer, intent(out)  rc  )

private

Called by NUOPC to advertise import and export fields. "Advertise" simply means that the standard names of all import and export fields are supplied. The NUOPC layer uses these to match fields between components in the coupled system.

Parameters

gcomp	an ESMF_GridComp object
importState	an ESMF_State object for import fields
exportState	an ESMF_State object for export fields
clock	an ESMF_Clock object
rc	return code

subroutine hycom::initializep0 ( type(esmf_gridcomp)  gcomp, type(esmf_state)  importState, type(esmf_state)  exportState, type(esmf_clock)  clock, integer, intent(out)  rc  )

private

First initialize subroutine called by NUOPC. The purpose is to set which version of the Initialize Phase Definition (IPD) to use.

For this HYCOM cap, we are using IPDv01.

Parameters

gcomp	an ESMF_GridComp object
importState	an ESMF_State object for import fields
exportState	an ESMF_State object for export fields
clock	an ESMF_Clock object
rc	return code

subroutine hycom::initializerealize ( type(esmf_gridcomp)  gcomp, type(esmf_state)  importState, type(esmf_state)  exportState, type(esmf_clock)  clock, integer, intent(out)  rc  )

private

Called by NUOPC to realize import and export fields. "Realizing" a field means that its grid has been defined and an ESMF_Field object has been created and put into the import or export State.

Parameters

gcomp	an ESMF_GridComp object
importState	an ESMF_State object for import fields
exportState	an ESMF_State object for export fields
clock	an ESMF_Clock object
rc	return code

subroutine hycom::modeladvance ( type(esmf_gridcomp)  gcomp, integer, intent(out)  rc  )

private

Called by NUOPC to advance the CICE model a single timestep.

Parameters

gcomp	an ESMF_GridComp object
rc	return code

subroutine, public hycom::setservices	(	type(esmf_gridcomp)	gcomp,
		integer, intent(out)	rc
	)

NUOPC SetService method is the only public entry point. SetServices registers all of the user-provided subroutines in the module with the NUOPC layer.

Parameters

gcomp	an ESMF_GridComp object
rc	return code

Member Data Documentation

logical hycom::atm_init = .true.

private

logical hycom::regional = .false.

private

logical hycom::restart = .false.

private

logical hycom::write_diagnostics = .false.

private

---

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

• hycom_nuopc.F90