CAMP 1.0.0
Chemistry Across Multiple Phases
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
camp_mechanism_data::mechanism_data_t Interface Reference

A chemical mechanism. More...

Public Member Functions

procedure load
 Load reactions from an input file. More...
 
procedure initialize
 Initialize the mechanism. More...
 
procedure name => get_name
 Get the mechanism name. More...
 
procedure size => get_size
 Get the size of the reaction database. More...
 
procedure get_rxn
 Get a reaction by its index. More...
 
procedure pack_size
 Determine the number of bytes required to pack the given value. More...
 
procedure bin_pack
 Packs the given value into the buffer, advancing position. More...
 
procedure bin_unpack
 Unpacks the given value from the buffer, advancing position. More...
 
procedure print => do_print
 Print the mechanism data. More...
 
final finalize
 Finalize the mechanism. More...
 
 finalize_array
 

Public Attributes

character(len=:), allocatable mech_name
 Mechanism name. More...
 
character(len=:), allocatable fixed_file_prefix
 Path and prefix for fixed module output. More...
 
type(rxn_data_ptr), dimension(:), pointer rxn_ptr => null()
 Reactions. More...
 

Private Member Functions

procedure, private ensure_size
 Ensure there is enough room in the reaction dataset to add a specified number of reactions. More...
 

Private Attributes

integer(kind=i_kind) num_rxn = 0
 Number of reactions. More...
 

Detailed Description

A chemical mechanism.

Instances of mechanism_data_t represent complete CAMP: Chemical Mechanism chemical mechanism. Multiple mechanisms may be used during one model run and will be solved simultaneously.

Definition at line 61 of file mechanism_data.F90.

Member Function/Subroutine Documentation

◆ bin_pack()

procedure camp_mechanism_data::mechanism_data_t::bin_pack

Packs the given value into the buffer, advancing position.

Definition at line 85 of file mechanism_data.F90.

◆ bin_unpack()

procedure camp_mechanism_data::mechanism_data_t::bin_unpack

Unpacks the given value from the buffer, advancing position.

Definition at line 87 of file mechanism_data.F90.

◆ ensure_size()

procedure, private camp_mechanism_data::mechanism_data_t::ensure_size
private

Ensure there is enough room in the reaction dataset to add a specified number of reactions.

Definition at line 96 of file mechanism_data.F90.

◆ finalize()

final camp_mechanism_data::mechanism_data_t::finalize
final

Finalize the mechanism.

Definition at line 91 of file mechanism_data.F90.

Here is the call graph for this function:

◆ finalize_array()

camp_mechanism_data::mechanism_data_t::finalize_array

Definition at line 91 of file mechanism_data.F90.

◆ get_rxn()

procedure camp_mechanism_data::mechanism_data_t::get_rxn

Get a reaction by its index.

Definition at line 81 of file mechanism_data.F90.

◆ initialize()

procedure camp_mechanism_data::mechanism_data_t::initialize

Initialize the mechanism.

Definition at line 75 of file mechanism_data.F90.

◆ load()

procedure camp_mechanism_data::mechanism_data_t::load

Load reactions from an input file.

Definition at line 73 of file mechanism_data.F90.

◆ name()

procedure camp_mechanism_data::mechanism_data_t::name

Get the mechanism name.

Definition at line 77 of file mechanism_data.F90.

◆ pack_size()

procedure camp_mechanism_data::mechanism_data_t::pack_size

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

Definition at line 83 of file mechanism_data.F90.

◆ print()

procedure camp_mechanism_data::mechanism_data_t::print

Print the mechanism data.

Definition at line 89 of file mechanism_data.F90.

◆ size()

procedure camp_mechanism_data::mechanism_data_t::size

Get the size of the reaction database.

Definition at line 79 of file mechanism_data.F90.

Member Data Documentation

◆ fixed_file_prefix

character(len=:), allocatable camp_mechanism_data::mechanism_data_t::fixed_file_prefix

Path and prefix for fixed module output.

Definition at line 68 of file mechanism_data.F90.

◆ mech_name

character(len=:), allocatable camp_mechanism_data::mechanism_data_t::mech_name

Mechanism name.

Definition at line 66 of file mechanism_data.F90.

◆ num_rxn

integer(kind=i_kind) camp_mechanism_data::mechanism_data_t::num_rxn = 0
private

Number of reactions.

Definition at line 64 of file mechanism_data.F90.

◆ rxn_ptr

type(rxn_data_ptr), dimension(:), pointer camp_mechanism_data::mechanism_data_t::rxn_ptr => null()

Reactions.

Definition at line 70 of file mechanism_data.F90.


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