camp_rxn_photolysis Module Reference

The rxn_photolysis_t type and associated functions. More...

Data Types
interface	rxn_free_update_data
	Free an update rate data object. More...
interface	rxn_photolysis_create_rate_update_data
	Interface to c reaction functions. More...
interface	rxn_photolysis_set_rate_update_data
	Set a new photolysis rate. More...
interface	rxn_photolysis_t
	Generic test reaction data type. More...
type	rxn_update_data_photolysis_t
	Photolysis rate update object. More...

Functions/Subroutines
type(rxn_photolysis_t) function, pointer	constructor ()
	Constructor for Photolysis reaction.
subroutine	initialize (this, chem_spec_data, aero_rep, n_cells)
	Initialize the reaction data, validating component data and loading any required information into the condensed data arrays for use during solving.
type(property_t) function, pointer	get_property_set (this)
	Get the reaction properties. (For use by external photolysis modules.)
subroutine	finalize (this)
	Finalize the reaction.
subroutine	finalize_array (this)
	Finalize an array of reactions.
subroutine	update_data_rate_set (this, base_rate)
	Set packed update data for photolysis rate constants.
subroutine	update_data_initialize (this, update_data, rxn_type)
	Initialize update data.
integer(kind=i_kind) function	internal_pack_size (this, comm)
	Determine the size of a binary required to pack the reaction data.
subroutine	internal_bin_pack (this, buffer, pos, comm)
	Pack the given value to the buffer, advancing position.
subroutine	internal_bin_unpack (this, buffer, pos, comm)
	Unpack the given value from the buffer, advancing position.
subroutine	update_data_finalize (this)
	Finalize an update data object.
subroutine	update_data_finalize_array (this)
	Finalize an array of update data objects.

Detailed Description

The rxn_photolysis_t type and associated functions.

Function/Subroutine Documentation

constructor()

type(rxn_photolysis_t) function, pointer camp_rxn_photolysis::constructor

private

Constructor for Photolysis reaction.

Returns

A new reaction instance

Definition at line 168 of file rxn_photolysis.F90.

finalize()

subroutine camp_rxn_photolysis::finalize ( type(rxn_photolysis_t), intent(inout)  this )

private

Finalize the reaction.

Parameters

[in,out]

this

Reaction data

Definition at line 328 of file rxn_photolysis.F90.

finalize_array()

subroutine camp_rxn_photolysis::finalize_array ( type(rxn_photolysis_t), dimension(:), intent(inout)  this )

private

Finalize an array of reactions.

Parameters

[in,out]

this

Array of reaction data

Definition at line 345 of file rxn_photolysis.F90.

Here is the call graph for this function:

get_property_set()

type(property_t) function, pointer camp_rxn_photolysis::get_property_set ( class(rxn_photolysis_t), intent(in)  this )

private

Get the reaction properties. (For use by external photolysis modules.)

Returns

Reaction properties

Parameters

[in]

this

Reaction data

Definition at line 314 of file rxn_photolysis.F90.

initialize()

subroutine camp_rxn_photolysis::initialize ( class(rxn_photolysis_t), intent(inout)  this, type(chem_spec_data_t), intent(in)  chem_spec_data, type(aero_rep_data_ptr), dimension(:), intent(in), pointer  aero_rep, integer(kind=i_kind), intent(in)  n_cells  )

private

Initialize the reaction data, validating component data and loading any required information into the condensed data arrays for use during solving.

Parameters

[in,out]	this	Reaction data
[in]	chem_spec_data	Chemical species data
[in]	aero_rep	Aerosol representations
[in]	n_cells	Number of grid cells to solve simultaneously

Definition at line 183 of file rxn_photolysis.F90.

Here is the call graph for this function:

internal_bin_pack()

subroutine camp_rxn_photolysis::internal_bin_pack ( class(rxn_update_data_photolysis_t), intent(in)  this, character, dimension(:), intent(inout)  buffer, integer, intent(inout)  pos, integer, intent(in)  comm  )

private

Pack the given value to the buffer, advancing position.

Parameters

[in]	this	Reaction update data
[in,out]	buffer	Memory buffer
[in,out]	pos	Current buffer position
[in]	comm	MPI communicator

Definition at line 419 of file rxn_photolysis.F90.

Here is the call graph for this function:

internal_bin_unpack()

subroutine camp_rxn_photolysis::internal_bin_unpack ( class(rxn_update_data_photolysis_t), intent(inout)  this, character, dimension(:), intent(inout)  buffer, integer, intent(inout)  pos, integer, intent(in)  comm  )

private

Unpack the given value from the buffer, advancing position.

Parameters

[in,out]	this	Reaction update data
[in,out]	buffer	Memory buffer
[in,out]	pos	Current buffer position
[in]	comm	MPI communicator

Definition at line 445 of file rxn_photolysis.F90.

Here is the call graph for this function:

internal_pack_size()

integer(kind=i_kind) function camp_rxn_photolysis::internal_pack_size ( class(rxn_update_data_photolysis_t), intent(in)  this, integer, intent(in)  comm  )

private

Determine the size of a binary required to pack the reaction data.

Parameters

[in]	this	Reaction update data
[in]	comm	MPI communicator

Definition at line 402 of file rxn_photolysis.F90.

Here is the call graph for this function:

update_data_finalize()

subroutine camp_rxn_photolysis::update_data_finalize ( type(rxn_update_data_photolysis_t), intent(inout)  this )

private

Finalize an update data object.

Parameters

[in,out]

this

Update data object to free

Definition at line 472 of file rxn_photolysis.F90.

Here is the caller graph for this function:

update_data_finalize_array()

subroutine camp_rxn_photolysis::update_data_finalize_array ( type(rxn_update_data_photolysis_t), dimension(:), intent(inout)  this )

private

Finalize an array of update data objects.

Parameters

[in,out]

this

Array of update data objects to free

Definition at line 484 of file rxn_photolysis.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

update_data_initialize()

subroutine camp_rxn_photolysis::update_data_initialize ( class(rxn_photolysis_t), intent(inout)  this, class(rxn_update_data_photolysis_t), intent(out)  update_data, integer(kind=i_kind), intent(in)  rxn_type  )

private

Initialize update data.

Parameters

[in,out]	this	The reaction to update
[out]	update_data	Update data object
[in]	rxn_type	Reaction type id

Definition at line 376 of file rxn_photolysis.F90.

Here is the call graph for this function:

update_data_rate_set()

subroutine camp_rxn_photolysis::update_data_rate_set ( class(rxn_update_data_photolysis_t), intent(inout)  this, real(kind=dp), intent(in)  base_rate  )

private

Set packed update data for photolysis rate constants.

Parameters

[in,out]	this	Update data
[in]	base_rate	Updated pre-scaling photolysis rate

Definition at line 361 of file rxn_photolysis.F90.