betrsimulation Module Reference

Data Types
type	betr_simulation_type

Functions/Subroutines
subroutine	setclock (this, dtime, nelapstep)
subroutine, public	betrsimulationinit (this, bounds, lun, col, pft, waterstate, namelist_buffer, masterproc)
subroutine	betrsimulationinitoffline (this, bounds, lun, col, pft, waterstate, namelist_buffer, base_filename)
subroutine	betrsetfilter (this, maxpft_per_col, boffline)
subroutine	betrinit (this, bounds, lun, col, pft, waterstate, namelist_buffer, base_filename, masterproc)
subroutine	betrsimulationrestartalloc (this, bounds)
subroutine	betrsimulationhistoryalloc (this, bounds)
subroutine	betrsimulationrestartopen (this, fname, flag, ncid)
subroutine	betrsimulationrestartclose (this, ncid)
subroutine	betrsimulationstepwithoutdrainage (this, bounds, col, pft)
subroutine	betrsimulationdiagnoselnd2atm (this, bounds, col, lnd2atm_vars)
subroutine	betrsimulationstepwithdrainage (this, bounds, col)
subroutine	betrsimulationbeginmassbalancecheck (this, bounds)
subroutine	betrsimulationmassbalancecheck (this, bounds)
subroutine	hist_htapes_create (this, bounds, betr_nlevtrc_soil, num_hist_state1d, num_hist_state2d, num_hist_flux1d, num_hist_flux2d)
subroutine	hist_write (this, bounds, record, numf, filter, time_vars, velocity)
subroutine	betrsimulationhistretrieval (this, bounds, numf, filter)
subroutine	betrsimulationconsistencycheck (this, bounds, ubj, num_soilc, filter_soilc, waterstate_vars)
subroutine	writeregressionoutput (this, velocity)
subroutine	betrsimulationsetbiophysforcing (this, bounds, col, pft, lbj, ubj, carbonflux_vars, waterstate_vars, waterflux_vars, temperature_vars, soilhydrology_vars, atm2lnd_vars, canopystate_vars, chemstate_vars, soilstate_vars)
subroutine	betrsimulationretrievebiogeoflux (this, bounds, lbj, ubj, carbonflux_vars, waterflux_vars)
subroutine	betrsimulationprediagsoilcolwaterflux (this, num_nolakec, filter_nolakec)
subroutine	betrsimulationdiagnosedtracerfreezethaw (this, bounds, num_nolakec, filter_nolakec, col, lun)
subroutine	betrsimulationdiagadvwaterflux (this, num_hydrologyc, filter_hydrologyc)
subroutine	betrsimulationdiagdrainwaterflux (this, num_hydrologyc, filter_hydrologyc)
subroutine	betrsimulationbegintracersnowlayeradjst (this, num_snowc, filter_snowc)
subroutine	betrsimulationendtracersnowlayeradjst (this, num_snowc, filter_snowc)
subroutine	betrsimulationdvidesnowlayers (this, bounds, num_snowc, filter_snowc, divide_matrix)
subroutine	betrsimulationcombinesnowlayers (this, bounds, num_snowc, filter_snowc, combine_matrix)
subroutine	hist_create_fluxes (this, bounds, betr_nlevtrc_soil, num_flux1d, num_flux2d, ncid)
subroutine	hist_create_states (this, bounds, betr_nlevtrc_soil, num_state1d, num_state2d, ncid)
subroutine	hist_output_fluxes (this, ncid, record, bounds, numf, filter, betr_nlevtrc_soil, num_flux1d, num_flux2d)
subroutine	hist_output_states (this, ncid, record, bounds, numf, filter, betr_nlevtrc_soil, num_state1d, num_state2d)
subroutine	betrsimulationcreatehistory (this, bounds, betr_nlevtrc_soil, num_state1d, num_state2d, num_flux1d, num_flux2d)
subroutine	betrsimulationretrievehistorystate (this, bounds, numf, filter)
subroutine	betrsimulationretrievehistoryflux (this, bounds, numf, filter)
subroutine	betrsimulationrestartoffline (this, bounds, ncid, numf, filter, flag)
subroutine	betrsimulationrestart (this, bounds, ncid, flag)
subroutine	betrsimulationsetcps (this, bounds, col, pft)
subroutine	betrsimulationsetbounds (this, betr_bounds)
logical function	do_soibgc (this)

Variables
character(len= *), parameter, private	mod_filename = __FILE__

Function/Subroutine Documentation

betrinit()

subroutine betrsimulation::betrinit	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(landunit_type), intent(in)	lun,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in)	pft,
		type(waterstate_type), intent(in)	waterstate,
		character(len=*), intent(in)	namelist_buffer,
		character(len=*), intent(in), optional	base_filename,
		logical, intent(in), optional	masterproc
	)

betrsetfilter()

subroutine betrsimulation::betrsetfilter	(	class(betr_simulation_type), intent(inout)	this,
		integer, intent(in)	maxpft_per_col,
		logical, intent(in)	boffline
	)

betrsimulationbeginmassbalancecheck()

subroutine betrsimulation::betrsimulationbeginmassbalancecheck	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds
	)

Here is the call graph for this function:

betrsimulationbegintracersnowlayeradjst()

subroutine betrsimulation::betrsimulationbegintracersnowlayeradjst	(	class(betr_simulation_type), intent(inout)	this,
		integer, intent(in)	num_snowc,
		integer, dimension(:), intent(in)	filter_snowc
	)

betrsimulationcombinesnowlayers()

subroutine betrsimulation::betrsimulationcombinesnowlayers	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	num_snowc,
		integer, dimension(:), intent(in)	filter_snowc,
		real(r8), dimension(bounds%begc:bounds%endc,-nlevsno+1:1 ,-nlevsno+1:1 ), intent(in)	combine_matrix
	)

betrsimulationconsistencycheck()

subroutine betrsimulation::betrsimulationconsistencycheck	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	ubj,
		integer, intent(in)	num_soilc,
		integer, dimension(:), intent(in)	filter_soilc,
		type(waterstate_type), intent(in)	waterstate_vars
	)

betrsimulationcreatehistory()

subroutine betrsimulation::betrsimulationcreatehistory	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_state1d,
		integer, intent(in)	num_state2d,
		integer, intent(in)	num_flux1d,
		integer, intent(in)	num_flux2d
	)

betrsimulationdiagadvwaterflux()

subroutine betrsimulation::betrsimulationdiagadvwaterflux	(	class(betr_simulation_type), intent(inout)	this,
		integer, intent(in)	num_hydrologyc,
		integer, dimension(:), intent(in)	filter_hydrologyc
	)

betrsimulationdiagdrainwaterflux()

subroutine betrsimulation::betrsimulationdiagdrainwaterflux ( class(betr_simulation_type), intent(inout)  this, integer, intent(in)  num_hydrologyc, integer, dimension(:), intent(in)  filter_hydrologyc  )

private

betrsimulationdiagnosedtracerfreezethaw()

subroutine betrsimulation::betrsimulationdiagnosedtracerfreezethaw ( class(betr_simulation_type), intent(inout)  this, type(bounds_type), intent(in)  bounds, integer, intent(in)  num_nolakec, integer, dimension(:), intent(in)  filter_nolakec, type(column_type), intent(in)  col, type(landunit_type), intent(in)  lun  )

private

betrsimulationdiagnoselnd2atm()

subroutine betrsimulation::betrsimulationdiagnoselnd2atm	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(column_type), intent(in)	col,
		type(lnd2atm_type), intent(inout)	lnd2atm_vars
	)

Here is the call graph for this function:

betrsimulationdvidesnowlayers()

subroutine betrsimulation::betrsimulationdvidesnowlayers	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	num_snowc,
		integer, dimension(:), intent(in)	filter_snowc,
		real(r8), dimension(bounds%begc:bounds%endc , 1:nlevsno , 1:nlevsno ), intent(in)	divide_matrix
	)

betrsimulationendtracersnowlayeradjst()

subroutine betrsimulation::betrsimulationendtracersnowlayeradjst	(	class(betr_simulation_type), intent(inout)	this,
		integer, intent(in)	num_snowc,
		integer, dimension(:), intent(in)	filter_snowc
	)

betrsimulationhistoryalloc()

subroutine betrsimulation::betrsimulationhistoryalloc ( class(betr_simulation_type), intent(inout)  this, type(bounds_type), intent(in)  bounds  )

private

betrsimulationhistretrieval()

subroutine betrsimulation::betrsimulationhistretrieval	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter
	)

betrsimulationinit()

subroutine, public betrsimulation::betrsimulationinit	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(landunit_type), intent(in)	lun,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in)	pft,
		type(waterstate_type), intent(inout)	waterstate,
		character(len=*), intent(in)	namelist_buffer,
		logical, intent(in), optional	masterproc
	)

Here is the caller graph for this function:

betrsimulationinitoffline()

subroutine betrsimulation::betrsimulationinitoffline	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(landunit_type), intent(in)	lun,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in)	pft,
		type(waterstate_type), intent(inout)	waterstate,
		character(len=*), intent(in)	namelist_buffer,
		character(len=*), intent(in)	base_filename
	)

betrsimulationmassbalancecheck()

subroutine betrsimulation::betrsimulationmassbalancecheck	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds
	)

Here is the call graph for this function:

betrsimulationprediagsoilcolwaterflux()

subroutine betrsimulation::betrsimulationprediagsoilcolwaterflux	(	class(betr_simulation_type), intent(inout)	this,
		integer, intent(in)	num_nolakec,
		integer, dimension(:), intent(in)	filter_nolakec
	)

betrsimulationrestart()

subroutine betrsimulation::betrsimulationrestart	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(file_desc_t), intent(inout)	ncid,
		character(len=*), intent(in)	flag
	)

betrsimulationrestartalloc()

subroutine betrsimulation::betrsimulationrestartalloc	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds
	)

betrsimulationrestartclose()

subroutine betrsimulation::betrsimulationrestartclose	(	class(betr_simulation_type), intent(inout)	this,
		type(file_desc_t), intent(inout)	ncid
	)

Here is the call graph for this function:

betrsimulationrestartoffline()

subroutine betrsimulation::betrsimulationrestartoffline	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(file_desc_t), intent(inout)	ncid,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter,
		character(len=*), intent(in)	flag
	)

Here is the call graph for this function:

betrsimulationrestartopen()

subroutine betrsimulation::betrsimulationrestartopen ( class(betr_simulation_type), intent(inout)  this, character(len=*), intent(in)  fname, character(len=*), intent(in)  flag, type(file_desc_t), intent(out)  ncid  )

private

Here is the call graph for this function:

betrsimulationretrievebiogeoflux()

subroutine betrsimulation::betrsimulationretrievebiogeoflux	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	lbj,
		integer, intent(in)	ubj,
		type(carbonflux_type), intent(inout), optional	carbonflux_vars,
		type(waterflux_type), intent(inout), optional	waterflux_vars
	)

betrsimulationretrievehistoryflux()

subroutine betrsimulation::betrsimulationretrievehistoryflux	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter
	)

betrsimulationretrievehistorystate()

subroutine betrsimulation::betrsimulationretrievehistorystate ( class(betr_simulation_type), intent(inout)  this, type(bounds_type), intent(in)  bounds, integer, intent(in)  numf, integer, dimension(:), intent(in)  filter  )

private

betrsimulationsetbiophysforcing()

subroutine betrsimulation::betrsimulationsetbiophysforcing	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in)	pft,
		integer, intent(in)	lbj,
		integer, intent(in)	ubj,
		type(carbonflux_type), intent(in), optional	carbonflux_vars,
		type(waterstate_type), intent(in), optional	waterstate_vars,
		type(waterflux_type), intent(in), optional	waterflux_vars,
		type(temperature_type), intent(in), optional	temperature_vars,
		type(soilhydrology_type), intent(in), optional	soilhydrology_vars,
		type(atm2lnd_type), intent(in), optional	atm2lnd_vars,
		type(canopystate_type), intent(in), optional	canopystate_vars,
		type(chemstate_type), intent(in), optional	chemstate_vars,
		type(soilstate_type), intent(in), optional	soilstate_vars
	)

Here is the call graph for this function:

betrsimulationsetbounds()

subroutine betrsimulation::betrsimulationsetbounds	(	class(betr_simulation_type), intent(inout)	this,
		type(betr_bounds_type), intent(out)	betr_bounds
	)

betrsimulationsetcps()

subroutine betrsimulation::betrsimulationsetcps	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in), optional	pft
	)

betrsimulationstepwithdrainage()

subroutine betrsimulation::betrsimulationstepwithdrainage	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(column_type), intent(in)	col
	)

Here is the call graph for this function:

betrsimulationstepwithoutdrainage()

subroutine betrsimulation::betrsimulationstepwithoutdrainage	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		type(column_type), intent(in)	col,
		type(patch_type), intent(in)	pft
	)

do_soibgc()

logical function betrsimulation::do_soibgc

(

class(betr_simulation_type), intent(inout)

this

)

hist_create_fluxes()

subroutine betrsimulation::hist_create_fluxes	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_flux1d,
		integer, intent(in)	num_flux2d,
		type(file_desc_t), intent(inout), optional	ncid
	)

Here is the call graph for this function:

hist_create_states()

subroutine betrsimulation::hist_create_states	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_state1d,
		integer, intent(in)	num_state2d,
		type(file_desc_t), intent(inout), optional	ncid
	)

Here is the call graph for this function:

hist_htapes_create()

subroutine betrsimulation::hist_htapes_create	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_hist_state1d,
		integer, intent(in)	num_hist_state2d,
		integer, intent(in)	num_hist_flux1d,
		integer, intent(in)	num_hist_flux2d
	)

Here is the call graph for this function:

hist_output_fluxes()

subroutine betrsimulation::hist_output_fluxes	(	class(betr_simulation_type), intent(inout)	this,
		type(file_desc_t), intent(inout)	ncid,
		integer, intent(in)	record,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_flux1d,
		integer, intent(in)	num_flux2d
	)

Here is the call graph for this function:

hist_output_states()

subroutine betrsimulation::hist_output_states	(	class(betr_simulation_type), intent(inout)	this,
		type(file_desc_t), intent(inout)	ncid,
		integer, intent(in)	record,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter,
		integer, intent(in)	betr_nlevtrc_soil,
		integer, intent(in)	num_state1d,
		integer, intent(in)	num_state2d
	)

Here is the call graph for this function:

hist_write()

subroutine betrsimulation::hist_write	(	class(betr_simulation_type), intent(inout)	this,
		type(bounds_type), intent(in)	bounds,
		integer, intent(in)	record,
		integer, intent(in)	numf,
		integer, dimension(:), intent(in)	filter,
		type(betr_time_type), intent(in)	time_vars,
		real(r8), dimension(:, :), intent(in)	velocity
	)

Here is the call graph for this function:

setclock()

subroutine betrsimulation::setclock	(	class(betr_simulation_type), intent(inout)	this,
		real(r8), intent(in)	dtime,
		integer, intent(in)	nelapstep
	)

writeregressionoutput()

subroutine betrsimulation::writeregressionoutput	(	class(betr_simulation_type), intent(inout)	this,
		real(r8), dimension(:, :), intent(in)	velocity
	)

Variable Documentation

mod_filename

character(len=*), parameter, private betrsimulation::mod_filename = __FILE__

private