full_coupler_mod::coupler_chksum_type Type Reference

The purpose of objects of coupler_chksum_type is to simplify the list of arguments required for chksum related subroutines in full_coupler_mod. The members of this type point to the model components. More...

Public Member Functions
procedure, public	initialize_coupler_chksum_obj (this, components_obj)
	associates the pointers above to model components
procedure, public	get_components_obj (this, components_obj)
	subroutine to retrieve the requested component of an object of this type
procedure, public	get_atmos_ice_land_ocean_chksums (this, id, timestep)
	subroutine to compute chksums for atmos - ocean
procedure, public	get_atmos_ice_land_chksums (this, id, timestep)
	subroutine to compute chksums for atmos_ice_land
procedure, public	get_slow_ice_chksums (this, id, timestep)
	subroutine to compute chskums for slow_ice
procedure, public	get_ocean_chksums (this, id, timestep)
	subroutine to compute chksums for ocean
procedure, public	get_coupler_chksums (this, id, timestep)
	subroutine to compute chksums for select fields

Private Attributes
type(coupler_components_type), pointer	components

Detailed Description

The purpose of objects of coupler_chksum_type is to simplify the list of arguments required for chksum related subroutines in full_coupler_mod. The members of this type point to the model components.

Member Function/Subroutine Documentation

get_atmos_ice_land_chksums()

procedure, public full_coupler_mod::coupler_chksum_type::get_atmos_ice_land_chksums	(	class(coupler_chksum_type), intent(in)	this,
		character(len=*), intent(in)	id,
		integer, intent(in)	timestep
	)

subroutine to compute chksums for atmos_ice_land

if (atm%pe) then
   call mpp_set_current_pelist(atm%pelist)
   call atmos_ice_land_chksum('MAIN_LOOP-', nc)
endif

If you are on the global pelist before you enter this routine using the above call, you can return to the global pelist by invoking

call mpp_set_current_pelist()

after you exit. This is only necessary if you need to return to the global pelist.

Parameters

[in]	this	self
[in]	id	id to label CHECKSUMS in stdout

get_atmos_ice_land_ocean_chksums()

procedure, public full_coupler_mod::coupler_chksum_type::get_atmos_ice_land_ocean_chksums	(	class(coupler_chksum_type), intent(in)	this,
		character(len=*), intent(in)	id,
		integer, intent(in)	timestep
	)

subroutine to compute chksums for atmos - ocean

Parameters

[in]	this	self
[in]	id	ID labelling the set of checksums

get_components_obj()

procedure, public full_coupler_mod::coupler_chksum_type::get_components_obj	(	class(coupler_chksum_type), intent(in)	this,
		type(coupler_components_type), intent(out)	components_obj
	)

subroutine to retrieve the requested component of an object of this type

Parameters

[in]	this	coupler_chksum_type
[out]	components_obj	coupler_components_type to be returned

get_coupler_chksums()

procedure, public full_coupler_mod::coupler_chksum_type::get_coupler_chksums	(	class(coupler_chksum_type), intent(in)	this,
		character(len=*), intent(in)	id,
		integer, intent(in)	timestep
	)

subroutine to compute chksums for select fields

Parameters

[in]	this	self
[in]	id	id to label CHECKSUMS in stdout

get_ocean_chksums()

procedure, public full_coupler_mod::coupler_chksum_type::get_ocean_chksums	(	class(coupler_chksum_type), intent(in)	this,
		character(len=*), intent(in)	id,
		integer, intent(in)	timestep
	)

subroutine to compute chksums for ocean

if (ocean%is_ocean_pe) then
   call mpp_set_current_pelist(ocean%pelist)
   call ocean_chksum('MAIN_LOOP-', nc)
endif

If you are on the global pelist before you enter this routine using the above call, you can return to the global pelist by invoking

call mpp_set_current_pelist()

after you exit. This is only necessary if you need to return to the global pelist.

Parameters

[in]	this	self
[in]	id	ID labelling the set of CHECKSUMS

get_slow_ice_chksums()

procedure, public full_coupler_mod::coupler_chksum_type::get_slow_ice_chksums	(	class(coupler_chksum_type), intent(in)	this,
		character(len=*), intent(in)	id,
		integer, intent(in)	timestep
	)

subroutine to compute chskums for slow_ice

if (ice%slow_ice_pe) then
   call mpp_set_current_pelist(ice%slow_pelist)
   call slow_ice_chksum('MAIN_LOOP-', nc)
endif

If you are on the global pelist before you enter this routine using the above call, you can return to the global pelist by invoking

call mpp_set_current_pelist()

after you exit. This is only necessary if you need to return to the global pelist.

Parameters

[in]	this	self
[in]	id	id to label CHECKSUMS in stdout

initialize_coupler_chksum_obj()

procedure, public full_coupler_mod::coupler_chksum_type::initialize_coupler_chksum_obj	(	class(coupler_chksum_type), intent(inout)	this,
		type(coupler_components_type), intent(in), target	components_obj
	)

associates the pointers above to model components

Member Data Documentation

components

type(coupler_components_type), pointer full_coupler_mod::coupler_chksum_type::components

private

---

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

• full/full_coupler_mod.F90 (d27fe18b9e643a70ef25739048bed2f0dc83bfcf)