CAMP 1.0.0
Chemistry Across Multiple Phases
Public Member Functions | Public Attributes | Private Attributes | List of all members
camp_rxn_emission::rxn_update_data_emission_t Type Reference

Emission rate update object. More...

Inheritance diagram for camp_rxn_emission::rxn_update_data_emission_t:
Inheritance graph
[legend]
Collaboration diagram for camp_rxn_emission::rxn_update_data_emission_t:
Collaboration graph
[legend]

Public Member Functions

procedure set_rate (this, base_rate)
 Update the rate data.
 
procedure internal_pack_size (this, comm)
 Determine the pack size of the local update data.
 
procedure internal_bin_pack (this, buffer, pos, comm)
 Pack the local update data to a binary.
 
procedure internal_bin_unpack (this, buffer, pos, comm)
 Unpack the local update data from a binary.
 
final update_data_finalize (this)
 Finalize the rate update data.
 
- Public Member Functions inherited from camp_rxn_data::rxn_update_data_t
procedure get_type (this)
 Get the reaction type.
 
procedure get_cell_id (this)
 Get the grid cell to update.
 
procedure get_data (this)
 Get the update data.
 
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(internal_pack_size), deferred internal_pack_size internal_pack_size
 Extending type pack size (internal use only)
 
procedure(internal_bin_pack), deferred internal_bin_pack internal_bin_pack
 Extending type bin pack (internal use only)
 
procedure(internal_bin_unpack), deferred internal_bin_unpack internal_bin_unpack
 Extending type bin unpack (internal use only)
 
procedure print (this, file_unit)
 Print the update data.
 

Public Attributes

integer(kind=i_kind) rxn_unique_id = 0
 Unique id for finding reactions during model initialization.
 
- Public Attributes inherited from camp_rxn_data::rxn_update_data_t
integer(kind=c_int) rxn_type
 Reaction type.
 
integer(kind=c_int) rxn_solver_id = 0
 Index for this reaction in the solver data.
 
integer(kind=c_int) cell_id = 1
 Grid cell to update.
 
type(c_ptr) update_data
 Update data.
 

Private Attributes

logical is_malloced = .false.
 Flag indicating whether the update data as been allocated.
 

Detailed Description

Emission rate update object.

Definition at line 95 of file rxn_emission.F90.

Constructor & Destructor Documentation

◆ update_data_finalize()

final camp_rxn_emission::rxn_update_data_emission_t::update_data_finalize ( type(rxn_update_data_emission_t), intent(inout)  this)
final

Finalize the rate update data.

Parameters
[in,out]thisUpdate data object to free

Definition at line 111 of file rxn_emission.F90.

Here is the call graph for this function:

Member Function/Subroutine Documentation

◆ internal_bin_pack()

procedure camp_rxn_emission::rxn_update_data_emission_t::internal_bin_pack ( class(rxn_update_data_emission_t), intent(in)  this,
character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  pos,
integer, intent(in)  comm 
)

Pack the local update data to a binary.

Parameters
[in]thisReaction update data
[in,out]bufferMemory buffer
[in,out]posCurrent buffer position
[in]commMPI communicator

Definition at line 107 of file rxn_emission.F90.

◆ internal_bin_unpack()

procedure camp_rxn_emission::rxn_update_data_emission_t::internal_bin_unpack ( class(rxn_update_data_emission_t), intent(inout)  this,
character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  pos,
integer, intent(in)  comm 
)

Unpack the local update data from a binary.

Parameters
[in,out]thisReaction update data
[in,out]bufferMemory buffer
[in,out]posCurrent buffer position
[in]commMPI communicator

Definition at line 109 of file rxn_emission.F90.

◆ internal_pack_size()

procedure camp_rxn_emission::rxn_update_data_emission_t::internal_pack_size ( class(rxn_update_data_emission_t), intent(in)  this,
integer, intent(in)  comm 
)

Determine the pack size of the local update data.

Parameters
[in]thisReaction update data
[in]commMPI communicator

Definition at line 105 of file rxn_emission.F90.

◆ set_rate()

procedure camp_rxn_emission::rxn_update_data_emission_t::set_rate ( class(rxn_update_data_emission_t), intent(inout)  this,
real(kind=dp), intent(in)  base_rate 
)

Update the rate data.

Parameters
[in,out]thisUpdate data
[in]base_rateUpdated pre-scaling emission rate

Definition at line 103 of file rxn_emission.F90.

Member Data Documentation

◆ is_malloced

logical camp_rxn_emission::rxn_update_data_emission_t::is_malloced = .false.
private

Flag indicating whether the update data as been allocated.

Definition at line 98 of file rxn_emission.F90.

◆ rxn_unique_id

integer(kind=i_kind) camp_rxn_emission::rxn_update_data_emission_t::rxn_unique_id = 0

Unique id for finding reactions during model initialization.

Definition at line 100 of file rxn_emission.F90.


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