tuvx_heating_rates::heating_parameters_t Interface Reference

heating_parameters_t constructor More...

Public Member Functions
procedure	pack_size (this, comm)
	Returns the size of a character buffer needed to pack the heating parameters.
procedure	mpi_pack (this, buffer, position, comm)
	Packs the heating parameters into a character buffer.
procedure	mpi_unpack (this, buffer, position, comm)
	Unpacks the heating parameters from a character buffer.
type(heating_parameters_t) function	heating_parameters_constructor (config, grids, profiles)
	heating_parameters_t constructor

Public Attributes
type(string_t)	label_
type(cross_section_ptr)	cross_section_
type(quantum_yield_ptr)	quantum_yield_
real(kind=dk)	scaling_factor_
real(kind=dk), dimension(:), allocatable	energy_

Detailed Description

heating_parameters_t constructor

Member Function/Subroutine Documentation

heating_parameters_constructor()

type(heating_parameters_t) function tuvx_heating_rates::heating_parameters_t::heating_parameters_constructor	(	type(config_t), intent(inout)	config,
		type(grid_warehouse_t), intent(inout)	grids,
		type(profile_warehouse_t), intent(inout)	profiles )

heating_parameters_t constructor

Returns

Heating parameters for a single photolyzing species

Parameters

[in,out]

config

Configuration for the photolysis reaction

mpi_pack()

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

Packs the heating parameters into a character buffer.

Parameters

[in]	this	Heating parameters for a single photolyzing species
[in,out]	buffer	Character buffer
[in,out]	position	Position in the buffer
[in]	comm	MPI communicator

mpi_unpack()

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

Unpacks the heating parameters from a character buffer.

Parameters

[out]	this	Heating parameters for a single photolyzing species
[in,out]	buffer	Character buffer
[in,out]	position	Position in the buffer
[in]	comm	MPI communicator

pack_size()

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

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

Parameters

[in]	this	Heating parameters for a single photolyzing species
[in]	comm	MPI communicator

Returns

Size of the character buffer

---

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