tuvx_photolysis_rates::photolysis_rates_t Interface Reference

photolysis_rates_t constructor More...

Public Member Functions
procedure	add (this, config, grid_warehouse, profile_warehouse)
	Adds a photolysis rate to the collection.
procedure	get (this, la_srb, spherical_geometry, grid_warehouse, profile_warehouse, radiation_field, photolysis_rates, file_tag)
	calculate photolysis rate constants
procedure	get_cross_section (this, reaction_label, found)
	Returns a copy of a photolysis reaction cross section.
procedure	get_quantum_yield (this, reaction_label, found)
	Returns a copy of a photolysis reaction quantum yield.
procedure	labels (this)
	Returns the names of each photolysis reaction.
procedure	size (this)
	Returns the number of photolysis reactions.
procedure	pack_size (this, comm)
procedure	mpi_pack (this, buffer, position, comm)
procedure	mpi_unpack (this, buffer, position, comm)
final	finalize (this)
	Finalize the photorates rates.
class(photolysis_rates_t) function, pointer	constructor (photolysis_config, grid_warehouse, profile_warehouse)
	Constructor of photolysis_rates_t objects.

Public Attributes
type(quantum_yield_ptr), dimension(:), allocatable	quantum_yields_
real(dk), dimension(:), allocatable	scaling_factors_
type(string_t), dimension(:), allocatable	handles_
integer, dimension(:), allocatable	o2_rate_indices_
logical	enable_diagnostics_
type(grid_warehouse_ptr)	height_grid_
type(grid_warehouse_ptr)	wavelength_grid_
type(profile_warehouse_ptr)	etfl_profile_
type(profile_warehouse_ptr)	air_profile_

Private Attributes
type(cross_section_ptr), dimension(:), allocatable	cross_sections_

Detailed Description

photolysis_rates_t constructor

Constructor & Destructor Documentation

finalize()

final tuvx_photolysis_rates::photolysis_rates_t::finalize ( type(photolysis_rates_t), intent(inout) this )

final

Finalize the photorates rates.

Parameters

[in,out]

this

Photolysis rate calculator

Member Function/Subroutine Documentation

add()

procedure tuvx_photolysis_rates::photolysis_rates_t::add	(	class(photolysis_rates_t), intent(inout)	this,
		type(config_t), intent(inout)	config,
		type(grid_warehouse_t), intent(inout)	grid_warehouse,
		type(profile_warehouse_t), intent(inout)	profile_warehouse )

Adds a photolysis rate to the collection.

Parameters

[in,out]	this	photolysis rate constant calculator
[in,out]	config	photolysis reaction data
[in,out]	grid_warehouse	grid warehouse
[in,out]	profile_warehouse	profile warehouse

constructor()

class(photolysis_rates_t) function, pointer tuvx_photolysis_rates::photolysis_rates_t::constructor	(	type(config_t), intent(inout)	photolysis_config,
		type(grid_warehouse_t), intent(inout)	grid_warehouse,
		type(profile_warehouse_t), intent(inout)	profile_warehouse )

Constructor of photolysis_rates_t objects.

Parameters

[in,out]	photolysis_config	photorates rates Arguments
[in,out]	grid_warehouse	grid warehouse
[in,out]	profile_warehouse	profile warehouse

Returns

New photorates rates

get()

procedure tuvx_photolysis_rates::photolysis_rates_t::get	(	class(photolysis_rates_t), intent(inout)	this,
		type(la_sr_bands_t), intent(inout)	la_srb,
		type(spherical_geometry_t), intent(inout)	spherical_geometry,
		type(grid_warehouse_t), intent(inout)	grid_warehouse,
		type(profile_warehouse_t), intent(inout)	profile_warehouse,
		type(radiation_field_t), intent(in)	radiation_field,
		real(dk), dimension(:,:), intent(inout)	photolysis_rates,
		character(len=*), intent(in)	file_tag )

calculate photolysis rate constants

Parameters

[in,out]	this	Photolysis rate constant calculator
[in,out]	spherical_geometry	Spherical geometry
[in,out]	la_srb	Lyman Alpha, Schumann-Runge bands
[in,out]	grid_warehouse	Grid warehouse
[in,out]	profile_warehouse	Profile warehouse
[in]	radiation_field	Actinic flux
[in]	file_tag	Tag used in file name of output data
[in,out]	photolysis_rates	Calculated photolysis rate constants

get_cross_section()

procedure tuvx_photolysis_rates::photolysis_rates_t::get_cross_section	(	class(photolysis_rates_t), intent(in)	this,
		type(string_t), intent(in)	reaction_label,
		logical, intent(out), optional	found )

Returns a copy of a photolysis reaction cross section.

Parameters

[in]	this	Photolysis reactions
[in]	reaction_label	Reaction label to get cross section for
[out]	found	Flag indicating whether the reaction was found

Returns

Copy of cross section

get_quantum_yield()

procedure tuvx_photolysis_rates::photolysis_rates_t::get_quantum_yield	(	class(photolysis_rates_t), intent(in)	this,
		type(string_t), intent(in)	reaction_label,
		logical, intent(out), optional	found )

Returns a copy of a photolysis reaction quantum yield.

Parameters

[in]	this	Photolysis reactions
[in]	reaction_label	Reaction label to get cross section for
[out]	found	Flag indicating whether the reaction was found

Returns

Copy of quantum yield

labels()

procedure tuvx_photolysis_rates::photolysis_rates_t::labels

(

class(photolysis_rates_t), intent(in)

this

)

Returns the names of each photolysis reaction.

Returns

Photolysis reaction names

Parameters

[in]

this

Photolysis rate calculator

size()

procedure tuvx_photolysis_rates::photolysis_rates_t::size

(

class(photolysis_rates_t), intent(in)

this

)

Returns the number of photolysis reactions.

Parameters

[in]

this

Photolysis rate calculator

---

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

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