tuvx_output::output_t Interface Reference

Writer class for TUV-x data. More...

Public Member Functions
procedure	output (this, step, core, photolysis_rate_constants, dose_rates, heating_rates, time, solar_zenith_angle, earth_sun_distance)
	Outputs results.
final	finalize_output_t (this)
	Cleans up memory.
type(output_t) function, pointer	constructor (config, core)
	Creates an output_t object for a given set of variables.

Public Attributes
logical	do_photo_ = .false.
logical	do_dose_ = .false.
logical	do_heating_ = .false.
logical	do_radiation_ = .false.
type(string_t), dimension(:), allocatable	photo_labels_
type(string_t), dimension(:), allocatable	dose_labels_
type(string_t), dimension(:), allocatable	heating_labels_
type(string_t), dimension(:), allocatable	photo_cross_sections_
type(string_t), dimension(:), allocatable	photo_quantum_yields_

Private Member Functions
procedure, private	add_grids (this, core)
	Adds grids to the output.
procedure, private	add_photolysis_diagnostics (this, config)
	Adds photolysis diagnostics to the output.

Private Attributes
class(io_t), pointer	file_ => null( )

Detailed Description

Writer class for TUV-x data.

Instances of output_t can be used by host applications to write TUV-x data and diagnostics to a file.

Member Function/Subroutine Documentation

add_grids()

procedure, private tuvx_output::output_t::add_grids ( class(output_t), intent(inout) this, class(core_t), intent(inout) core )

private

Adds grids to the output.

Grids are used as dimensions in the output

output()

procedure tuvx_output::output_t::output	(	class(output_t), intent(inout)	this,
		integer, intent(in)	step,
		class(core_t), intent(in)	core,
		real(dk), dimension(:,:), intent(in), optional	photolysis_rate_constants,
		real(dk), dimension(:,:), intent(in), optional	dose_rates,
		real(dk), dimension(:,:), intent(in), optional	heating_rates,
		real(dk), intent(in), optional	time,
		real(dk), intent(in), optional	solar_zenith_angle,
		real(dk), intent(in), optional	earth_sun_distance )

Outputs results.

Parameters

[in]	step	Output step (time, sza, etc.)
[in]	core	TUV-x core
[in]	photolysis_rate_constants	Photolysis rate constants [s-1] (vertical level, reaction)
[in]	dose_rates	Dose rates (vertical level, dose rate type)
[in]	heating_rates	Heating rates (vertical level, reaction)
[in]	time	Time [hours]
[in]	solar_zenith_angle	Solar zenith angle [degrees]
[in]	earth_sun_distance	Earth-Sun distance [AU]

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/tuv-x/checkouts/latest/src/output.F90