camp_rxn_photolysis::rxn_photolysis_t Interface Reference

Generic test reaction data type. More...

Inheritance diagram for camp_rxn_photolysis::rxn_photolysis_t:

Collaboration diagram for camp_rxn_photolysis::rxn_photolysis_t:

Public Member Functions
procedure	initialize (this, chem_spec_data, aero_rep, n_cells)
	Reaction initialization.
procedure	get_property_set (this)
	Get the reaction property set.
procedure	update_data_initialize (this, update_data, rxn_type)
	Initialize update data.
final	finalize (this)
	Finalize the reaction.
Public Member Functions inherited from camp_rxn_data::rxn_data_t
procedure(initialize), deferred	initialize initialize
	Reaction initialization. Takes species, phase and reaction parameters and packs required information into the condensed data arrays for use during the model run.
procedure	load (this, json, j_obj)
	Load data from an input file.
procedure	check_phase (this, rxn_phase)
	Check the phase of the reaction against the phase being solved for. During GAS_RXN integrations, only GAS_RXN reactions are solved. During AERO_RXN integrations, only AERO_RXN and GAS_AERO_RXN reactions are solved. During GAS_AERO_RXN integrations, all reactions are solved.
procedure	pack_size (this, comm)
	Determine the number of bytes required to pack the given value.
procedure	bin_pack (this, buffer, pos, comm)
	Packs the given value into the buffer, advancing position.
procedure	bin_unpack (this, buffer, pos, comm)
	Unpacks the given value from the buffer, advancing position.
procedure	print (this, file_unit)
	Print the reaction data.

Additional Inherited Members
Public Attributes inherited from camp_rxn_data::rxn_data_t
integer(kind=i_kind), public	rxn_phase
	Reaction phase.
type(property_t), pointer, public	property_set => null()
	Reaction parameters. These will be available during initialization, but not during integration. All information required to calculate the time derivatives and Jacobian matrix constributions must be saved by the exdending type.
real(kind=dp), dimension(:), allocatable, public	condensed_data_real
	Condensed reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions that cannot be obtained from the camp_camp_state::camp_state_t object. (floating-point)
integer(kind=i_kind), dimension(:), allocatable, public	condensed_data_int
	Condensed reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions that cannot be obtained from the camp_camp_state::camp_state_t object. (integer)
integer(kind=i_kind), public	num_env_params = 0
	Number of environment-dependent parameters These are parameters that need updated when environmental conditions change.

Detailed Description

Generic test reaction data type.

Constructor for rxn_photolysis_t.

Definition at line 94 of file rxn_photolysis.F90.

Constructor & Destructor Documentation

finalize()

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

final

Finalize the reaction.

Parameters

[in,out]

this

Reaction data

Definition at line 103 of file rxn_photolysis.F90.

Here is the call graph for this function:

Member Function/Subroutine Documentation

get_property_set()

procedure camp_rxn_photolysis::rxn_photolysis_t::get_property_set

(

class(rxn_photolysis_t), intent(in)

this

)

Get the reaction property set.

Returns

Reaction properties

Parameters

[in]

this

Reaction data

Definition at line 99 of file rxn_photolysis.F90.

initialize()

procedure camp_rxn_photolysis::rxn_photolysis_t::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
	)

Reaction initialization.

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 97 of file rxn_photolysis.F90.

update_data_initialize()

procedure camp_rxn_photolysis::rxn_photolysis_t::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
	)

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 101 of file rxn_photolysis.F90.

---

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

• rxn_photolysis.F90