stock_constants_mod

Parameters, routines, and types for computing stocks in xgrid_mod. More...

Data Types
type	stock_type
	Holds stocks amounts per PE values. More...

Functions/Subroutines
subroutine, public	stocks_report (time)
	Writes update to stock report.
subroutine, public	stocks_report_init (time)
	Starts a stock report.
subroutine, public	stocks_set_init_time (time)

Variables
type(stock_type), dimension(nelems), save, public	atm_stock
character(len=3), dimension(ncomps), parameter	comp_names =(/'ATM', 'LND', 'ICE', 'OCN'/)
real(r8_kind), parameter	eps = 1.0e-10_r8_kind
type(stock_type), dimension(nelems), save, public	ice_stock
integer	id_conservation_check
integer	id_get_1_from_xgrid = 0
integer	id_get_1_from_xgrid_repro = 0
integer	id_get_2_from_xgrid = 0
integer	id_load_xgrid
integer	id_load_xgrid1
integer	id_load_xgrid2
integer	id_load_xgrid3
integer	id_load_xgrid4
integer	id_load_xgrid5
integer	id_put_1_to_xgrid_order_1 = 0
integer	id_put_1_to_xgrid_order_2 = 0
integer	id_put_2_to_xgrid = 0
integer	id_regen
integer	id_set_comm
integer	id_setup_xmap = 0
integer	ie_nest =0
integer	ie_parent =0
type(time_type), save	init_time
integer	is_nest =0
integer	is_parent =0
integer, parameter, private	istock_atm =1
integer, parameter, public	istock_bottom =2
integer, parameter, public	istock_heat =2
integer, parameter, private	istock_ice =3
integer, parameter, private	istock_lnd =2
integer, parameter, private	istock_ocn =4
integer, parameter, public	istock_salt =3
integer, parameter, public	istock_side =3
integer, parameter, public	istock_top =1
integer, parameter, public	istock_water =1
integer	je_nest =0
integer	je_parent =0
integer	js_nest =0
integer	js_parent =0
real(r8_kind), parameter	large_number = 1.e20_r8_kind
type(stock_type), dimension(nelems), save, public	lnd_stock
logical	module_is_initialized = .FALSE.
integer, parameter, private	ncomps =4
integer, parameter	nelems_report =3
integer	nnest =0
integer, parameter	nsides = 3
	top, bottom, side
type(stock_type), dimension(nelems), save, public	ocn_stock
character(len=5), dimension(nelems), parameter	stock_names =(/'water', 'heat ', 'salt '/)
character(len=12), dimension(nelems), parameter	stock_units =(/'[Kg] ','[Joules]','[Kg] '/)
integer, public	stocks_file
integer	tile_nest
integer	tile_parent

Detailed Description

Parameters, routines, and types for computing stocks in xgrid_mod.

---

Data Type Documentation

stock_constants_mod::stock_type

type stock_constants_mod::stock_type

Holds stocks amounts per PE values.

Definition at line 53 of file stock_constants.F90.

Collaboration diagram for stock_type:

Public Attributes
real(r8_kind), dimension(nsides)	dq = 0.0_r8_kind
	stock increments at present time on the Ice grid
real(r8_kind), dimension(nsides)	dq_in = 0.0_r8_kind
	stock increments at present time on the Ocean grid
real(r8_kind)	q_now = 0.0_r8_kind
	total stocks at time t
real(r8_kind)	q_start = 0.0_r8_kind
	total stocks at start time

Member Data Documentation

dq

real(r8_kind), dimension(nsides) dq = 0.0_r8_kind

stock increments at present time on the Ice grid

Definition at line 60 of file stock_constants.F90.

dq_in

real(r8_kind), dimension(nsides) dq_in = 0.0_r8_kind

stock increments at present time on the Ocean grid

Definition at line 61 of file stock_constants.F90.

q_now

real(r8_kind) q_now = 0.0_r8_kind

total stocks at time t

Definition at line 55 of file stock_constants.F90.

q_start

real(r8_kind) q_start = 0.0_r8_kind

total stocks at start time

Definition at line 54 of file stock_constants.F90.

Function/Subroutine Documentation

stocks_report()

subroutine, public stocks_report

(

type(time_type), intent(in)

time

)

Writes update to stock report.

Parameters

[in]

time

Model time

Definition at line 170 of file stock_constants.F90.

stocks_report_init()

subroutine, public stocks_report_init

(

type(time_type), intent(in)

time

)

Starts a stock report.

Parameters

[in]

time

Model time

Definition at line 85 of file stock_constants.F90.

stocks_set_init_time()

subroutine, public stocks_set_init_time

(

type(time_type), intent(in)

time

)

Parameters

[in]

time

init time to set for stock report

Definition at line 336 of file stock_constants.F90.

Variable Documentation

atm_stock

type(stock_type), dimension(nelems), save, public atm_stock

Definition at line 66 of file stock_constants.F90.

comp_names

character(len=3), dimension(ncomps), parameter comp_names =(/'ATM', 'LND', 'ICE', 'OCN'/)

Definition at line 75 of file stock_constants.F90.

eps

real(r8_kind), parameter eps = 1.0e-10_r8_kind

private

Definition at line 459 of file xgrid.F90.

ice_stock

type(stock_type), dimension(nelems), save, public ice_stock

Definition at line 66 of file stock_constants.F90.

id_conservation_check

integer id_conservation_check

private

Definition at line 471 of file xgrid.F90.

id_get_1_from_xgrid

integer id_get_1_from_xgrid = 0

private

Definition at line 464 of file xgrid.F90.

id_get_1_from_xgrid_repro

integer id_get_1_from_xgrid_repro = 0

private

Definition at line 465 of file xgrid.F90.

id_get_2_from_xgrid

integer id_get_2_from_xgrid = 0

private

Definition at line 466 of file xgrid.F90.

id_load_xgrid

integer id_load_xgrid

private

Definition at line 471 of file xgrid.F90.

id_load_xgrid1

integer id_load_xgrid1

private

Definition at line 469 of file xgrid.F90.

id_load_xgrid2

integer id_load_xgrid2

private

Definition at line 469 of file xgrid.F90.

id_load_xgrid3

integer id_load_xgrid3

private

Definition at line 469 of file xgrid.F90.

id_load_xgrid4

integer id_load_xgrid4

private

Definition at line 470 of file xgrid.F90.

id_load_xgrid5

integer id_load_xgrid5

private

Definition at line 470 of file xgrid.F90.

id_put_1_to_xgrid_order_1

integer id_put_1_to_xgrid_order_1 = 0

private

Definition at line 462 of file xgrid.F90.

id_put_1_to_xgrid_order_2

integer id_put_1_to_xgrid_order_2 = 0

private

Definition at line 463 of file xgrid.F90.

id_put_2_to_xgrid

integer id_put_2_to_xgrid = 0

private

Definition at line 467 of file xgrid.F90.

id_regen

integer id_regen

private

Definition at line 471 of file xgrid.F90.

id_set_comm

integer id_set_comm

private

Definition at line 471 of file xgrid.F90.

id_setup_xmap

integer id_setup_xmap = 0

private

Definition at line 468 of file xgrid.F90.

ie_nest

integer ie_nest =0

private

Definition at line 476 of file xgrid.F90.

ie_parent

integer ie_parent =0

private

Definition at line 477 of file xgrid.F90.

init_time

type(time_type), save init_time

Definition at line 67 of file stock_constants.F90.

is_nest

integer is_nest =0

private

Definition at line 476 of file xgrid.F90.

is_parent

integer is_parent =0

private

Definition at line 477 of file xgrid.F90.

istock_atm

integer, parameter, private istock_atm =1

private

Definition at line 74 of file stock_constants.F90.

istock_bottom

integer, parameter, public istock_bottom =2

Definition at line 42 of file stock_constants.F90.

istock_heat

integer, parameter, public istock_heat =2

Definition at line 41 of file stock_constants.F90.

istock_ice

integer, parameter, private istock_ice =3

private

Definition at line 74 of file stock_constants.F90.

istock_lnd

integer, parameter, private istock_lnd =2

private

Definition at line 74 of file stock_constants.F90.

istock_ocn

integer, parameter, private istock_ocn =4

private

Definition at line 74 of file stock_constants.F90.

istock_salt

integer, parameter, public istock_salt =3

Definition at line 41 of file stock_constants.F90.

istock_side

integer, parameter, public istock_side =3

Definition at line 42 of file stock_constants.F90.

istock_top

integer, parameter, public istock_top =1

Definition at line 42 of file stock_constants.F90.

istock_water

integer, parameter, public istock_water =1

Definition at line 41 of file stock_constants.F90.

je_nest

integer je_nest =0

private

Definition at line 476 of file xgrid.F90.

je_parent

integer je_parent =0

private

Definition at line 477 of file xgrid.F90.

js_nest

integer js_nest =0

private

Definition at line 476 of file xgrid.F90.

js_parent

integer js_parent =0

private

Definition at line 477 of file xgrid.F90.

large_number

real(r8_kind), parameter large_number = 1.e20_r8_kind

private

Definition at line 460 of file xgrid.F90.

lnd_stock

type(stock_type), dimension(nelems), save, public lnd_stock

Definition at line 66 of file stock_constants.F90.

module_is_initialized

logical module_is_initialized = .FALSE.

private

Definition at line 461 of file xgrid.F90.

ncomps

integer, parameter, private ncomps =4

private

Definition at line 73 of file stock_constants.F90.

nelems_report

integer, parameter nelems_report =3

Definition at line 40 of file stock_constants.F90.

nnest

integer nnest =0

private

Definition at line 475 of file xgrid.F90.

nsides

integer, parameter nsides = 3

top, bottom, side

Definition at line 48 of file stock_constants.F90.

ocn_stock

type(stock_type), dimension(nelems), save, public ocn_stock

Definition at line 66 of file stock_constants.F90.

stock_names

character(len=5), dimension(nelems), parameter stock_names =(/'water', 'heat ', 'salt '/)

Definition at line 78 of file stock_constants.F90.

stock_units

character(len=12), dimension(nelems), parameter stock_units =(/'[Kg] ','[Joules]','[Kg] '/)

Definition at line 79 of file stock_constants.F90.

stocks_file

integer, public stocks_file

Definition at line 43 of file stock_constants.F90.

tile_nest

integer tile_nest

private

Definition at line 475 of file xgrid.F90.

tile_parent

integer tile_parent

private

Definition at line 475 of file xgrid.F90.