CAMP 1.0.0
Chemistry Across Multiple Phases
Public Member Functions | Public Attributes | List of all members
camp_rxn_data::rxn_update_data_t Type Referenceabstract

Update cookie. More...

Inheritance diagram for camp_rxn_data::rxn_update_data_t:
Inheritance graph
[legend]

Public Member Functions

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=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.
 

Detailed Description

Update cookie.

Definition at line 159 of file rxn_data.F90.

Member Function/Subroutine Documentation

◆ bin_pack()

procedure camp_rxn_data::rxn_update_data_t::bin_pack ( class(rxn_update_data_t), intent(in)  this,
character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  pos,
integer, intent(in), optional  comm 
)

Packs the given value into the buffer, advancing position.

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

Definition at line 178 of file rxn_data.F90.

◆ bin_unpack()

procedure camp_rxn_data::rxn_update_data_t::bin_unpack ( class(rxn_update_data_t), intent(out)  this,
character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  pos,
integer, intent(in), optional  comm 
)

Unpacks the given value from the buffer, advancing position.

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

Definition at line 180 of file rxn_data.F90.

◆ get_cell_id()

procedure camp_rxn_data::rxn_update_data_t::get_cell_id ( class(rxn_update_data_t), intent(in)  this)

Get the grid cell to update.

Returns
Grid cell id
Parameters
[in]thisUpdate data

Definition at line 172 of file rxn_data.F90.

◆ get_data()

procedure camp_rxn_data::rxn_update_data_t::get_data ( class(rxn_update_data_t), intent(in)  this)

Get the update data.

Returns
Update data ptr
Parameters
[in]thisUpdate data

Definition at line 174 of file rxn_data.F90.

◆ get_type()

procedure camp_rxn_data::rxn_update_data_t::get_type ( class(rxn_update_data_t), intent(in)  this)

Get the reaction type.

Returns
Reaction type
Parameters
[in]thisUpdate data

Definition at line 170 of file rxn_data.F90.

◆ internal_bin_pack()

procedure(internal_bin_pack), deferred camp_rxn_data::rxn_update_data_t::internal_bin_pack
pure virtual

Extending type bin pack (internal use only)

Definition at line 184 of file rxn_data.F90.

◆ internal_bin_unpack()

procedure(internal_bin_unpack), deferred camp_rxn_data::rxn_update_data_t::internal_bin_unpack
pure virtual

Extending type bin unpack (internal use only)

Definition at line 186 of file rxn_data.F90.

◆ internal_pack_size()

procedure(internal_pack_size), deferred camp_rxn_data::rxn_update_data_t::internal_pack_size
pure virtual

Extending type pack size (internal use only)

Definition at line 182 of file rxn_data.F90.

◆ pack_size()

procedure camp_rxn_data::rxn_update_data_t::pack_size ( class(rxn_update_data_t), intent(in)  this,
integer, intent(in), optional  comm 
)

Determine the number of bytes required to pack the given value.

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

Definition at line 176 of file rxn_data.F90.

◆ print()

procedure camp_rxn_data::rxn_update_data_t::print ( class(rxn_update_data_t), intent(in)  this,
integer(kind=i_kind), optional  file_unit 
)

Print the update data.

Parameters
[in]thisReaction update data
file_unitFile unit for output

Definition at line 188 of file rxn_data.F90.

Member Data Documentation

◆ cell_id

integer(kind=c_int) camp_rxn_data::rxn_update_data_t::cell_id = 1

Grid cell to update.

Definition at line 165 of file rxn_data.F90.

◆ rxn_solver_id

integer(kind=c_int) camp_rxn_data::rxn_update_data_t::rxn_solver_id = 0

Index for this reaction in the solver data.

Definition at line 163 of file rxn_data.F90.

◆ rxn_type

integer(kind=c_int) camp_rxn_data::rxn_update_data_t::rxn_type

Reaction type.

Definition at line 161 of file rxn_data.F90.

◆ update_data

type(c_ptr) camp_rxn_data::rxn_update_data_t::update_data

Update data.

Definition at line 167 of file rxn_data.F90.


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