tuvx_heating_rates::heating_rates_t Interface Reference

heating_rates_t constructor More...

Public Member Functions
procedure	get (this, la_srb, spherical_geometry, grids, profiles, radiation_field, heating_rates)
	Calulates the heating rates.
procedure	labels (this)
	Returns the names of each photolysis reaction with a heating rate.
procedure	size (this)
	Returns the number of heating rates.
procedure	pack_size (this, comm)
	Returns the size of a character buffer needed to pack the heating rates.
procedure	mpi_pack (this, buffer, position, comm)
	Packs the heating rates into a character buffer.
procedure	mpi_unpack (this, buffer, position, comm)
	Unpacks the heating rates from a character buffer.
final	destructor (this)
	Cleans up memory.
type(heating_rates_t) function, pointer	constructor (config, grids, profiles)
	heating_rates_t constructor

Public Attributes
type(heating_parameters_t), dimension(:), allocatable	heating_parameters_
type(grid_warehouse_ptr)	height_grid_
type(grid_warehouse_ptr)	wavelength_grid_
type(profile_warehouse_ptr)	etfl_profile_
type(profile_warehouse_ptr)	air_profile_
integer, dimension(:), allocatable	o2_rate_indices_

Detailed Description

heating_rates_t constructor

Constructor & Destructor Documentation

destructor()

final tuvx_heating_rates::heating_rates_t::destructor ( type(heating_rates_t), intent(inout) this )

final

Cleans up memory.

Parameters

[in,out]

this

Heating rates

Member Function/Subroutine Documentation

constructor()

type(heating_rates_t) function, pointer tuvx_heating_rates::heating_rates_t::constructor	(	type(config_t), intent(inout)	config,
		type(grid_warehouse_t), intent(inout)	grids,
		type(profile_warehouse_t), intent(inout)	profiles )

heating_rates_t constructor

Returns

Heating rate collection

Parameters

[in,out]

config

Configuration

get()

procedure tuvx_heating_rates::heating_rates_t::get	(	class(heating_rates_t), intent(in)	this,
		class(la_sr_bands_t), intent(inout)	la_srb,
		class(spherical_geometry_t), intent(inout)	spherical_geometry,
		class(grid_warehouse_t), intent(inout)	grids,
		class(profile_warehouse_t), intent(inout)	profiles,
		class(radiation_field_t), intent(in)	radiation_field,
		real(kind=dk), dimension(:,:), intent(inout)	heating_rates )

Calulates the heating rates.

Parameters

[in]	this	Heating rate collection
[in,out]	la_srb	Lyman Alpha and Schumann-Runge bands
[in,out]	spherical_geometry	Spherical geometry
[in]	radiation_field	Radiation field
[in,out]	heating_rates	Heating rates (vertical interface, reaction) [J s-1]

labels()

procedure tuvx_heating_rates::heating_rates_t::labels

(

class(heating_rates_t), intent(in)

this

)

Returns the names of each photolysis reaction with a heating rate.

Parameters

[in]

this

Heating rate collection

Returns

Photolysis reaction labels

mpi_pack()

procedure tuvx_heating_rates::heating_rates_t::mpi_pack	(	class(heating_rates_t), intent(in)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	position,
		integer, intent(in)	comm )

Packs the heating rates into a character buffer.

Parameters

[in]	this	Heating rate collection
[in,out]	buffer	Character buffer
[in,out]	position	Position in the buffer
[in]	comm	MPI communicator

mpi_unpack()

procedure tuvx_heating_rates::heating_rates_t::mpi_unpack	(	class(heating_rates_t), intent(out)	this,
		character, dimension(:), intent(inout)	buffer,
		integer, intent(inout)	position,
		integer, intent(in)	comm )

Unpacks the heating rates from a character buffer.

Parameters

[out]	this	Heating rate collection
[in,out]	buffer	Character buffer
[in,out]	position	Position in the buffer
[in]	comm	MPI communicator

pack_size()

procedure tuvx_heating_rates::heating_rates_t::pack_size	(	class(heating_rates_t), intent(in)	this,
		integer, intent(in)	comm )

Returns the size of a character buffer needed to pack the heating rates.

Parameters

[in]	this	Heating rate collection
[in]	comm	MPI communicator

Returns

Size of the character buffer

size()

procedure tuvx_heating_rates::heating_rates_t::size

(

class(heating_rates_t), intent(in)

this

)

Returns the number of heating rates.

Returns

Number of heating rates

Parameters

[in]

this

Heating rate collection

---

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

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