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

Aerosol phase data type. More...

Public Member Functions

procedure load
 Load data from an input file. More...
 
procedure initialize
 Aerosol phase initialization. More...
 
procedure name => get_name
 Get the name of the aerosol phase. More...
 
procedure size => get_size
 Get the number of species in the phase. More...
 
procedure num_jac_elem
 Get the number of Jacobian row elements needed during solving. More...
 
procedure get_property_set
 Get property data associated with this phase. More...
 
procedure get_species_names
 Get a list of species names in this phase. More...
 
procedure get_species_type
 Get a species type by name. 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 aerosol phase data. More...
 
final finalize
 Finalize the aerosol phase data. More...
 

Public Attributes

integer(kind=i_kind) num_spec = 0
 Number of species in the phase. More...
 
type(string_t), dimension(:), pointer spec_name => null()
 Species names. These are species that are present in the aerosol phase. These species must exist in the camp_camp_core::camp_core_t::chem_spec_data variable during initialization. More...
 
type(property_t), pointer property_set => null()
 Aerosol phase parameters. These will be available during initialization, but not during solving. More...
 
real(kind=dp), dimension(:), allocatable, public condensed_data_real
 Condensed phase data. Theses arrays will be available during solving, and should contain any information required by the functions of the aerosol phase that cannot be obtained from the camp_camp_state::camp_state_t object. (floating-point) More...
 
integer(kind=i_kind), dimension(:), allocatable, public condensed_data_int
 Condensed phase data. Theses arrays will be available during solving, and should contain any information required by the functions of the aerosol phase that cannot be obtained from the camp_camp_state::camp_state_t object. (integer) More...
 
type(chem_spec_data_t), pointer chem_spec_data
 Pointer to the set of chemical species data. More...
 

Private Member Functions

procedure, private ensure_size
 Ensure there is enough room in the species dataset to add a specified number of species. More...
 
procedure, private add
 Add a species. More...
 
procedure, private find
 Find a species index by name. More...
 

Private Attributes

character(len=:), allocatable phase_name
 Name of the aerosol phase. More...
 

Detailed Description

Aerosol phase data type.

Aerosol phase information.

Definition at line 78 of file aero_phase_data.F90.

Member Function/Subroutine Documentation

◆ add()

procedure, private camp_aero_phase_data::aero_phase_data_t::add
private

Add a species.

Definition at line 137 of file aero_phase_data.F90.

◆ bin_pack()

procedure camp_aero_phase_data::aero_phase_data_t::bin_pack

Packs the given value into the buffer, advancing position.

Definition at line 124 of file aero_phase_data.F90.

◆ bin_unpack()

procedure camp_aero_phase_data::aero_phase_data_t::bin_unpack

Unpacks the given value from the buffer, advancing position.

Definition at line 126 of file aero_phase_data.F90.

◆ ensure_size()

procedure, private camp_aero_phase_data::aero_phase_data_t::ensure_size
private

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

Definition at line 135 of file aero_phase_data.F90.

◆ finalize()

final camp_aero_phase_data::aero_phase_data_t::finalize
final

Finalize the aerosol phase data.

Definition at line 130 of file aero_phase_data.F90.

Here is the call graph for this function:

◆ find()

procedure, private camp_aero_phase_data::aero_phase_data_t::find
private

Find a species index by name.

Definition at line 139 of file aero_phase_data.F90.

◆ get_property_set()

procedure camp_aero_phase_data::aero_phase_data_t::get_property_set

Get property data associated with this phase.

Definition at line 116 of file aero_phase_data.F90.

◆ get_species_names()

procedure camp_aero_phase_data::aero_phase_data_t::get_species_names

Get a list of species names in this phase.

Definition at line 118 of file aero_phase_data.F90.

◆ get_species_type()

procedure camp_aero_phase_data::aero_phase_data_t::get_species_type

Get a species type by name.

Definition at line 120 of file aero_phase_data.F90.

◆ initialize()

procedure camp_aero_phase_data::aero_phase_data_t::initialize

Aerosol phase initialization.

Definition at line 108 of file aero_phase_data.F90.

◆ load()

procedure camp_aero_phase_data::aero_phase_data_t::load

Load data from an input file.

Definition at line 106 of file aero_phase_data.F90.

◆ name()

procedure camp_aero_phase_data::aero_phase_data_t::name

Get the name of the aerosol phase.

Definition at line 110 of file aero_phase_data.F90.

◆ num_jac_elem()

procedure camp_aero_phase_data::aero_phase_data_t::num_jac_elem

Get the number of Jacobian row elements needed during solving.

Definition at line 114 of file aero_phase_data.F90.

◆ pack_size()

procedure camp_aero_phase_data::aero_phase_data_t::pack_size

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

Definition at line 122 of file aero_phase_data.F90.

◆ print()

procedure camp_aero_phase_data::aero_phase_data_t::print

Print the aerosol phase data.

Definition at line 128 of file aero_phase_data.F90.

◆ size()

procedure camp_aero_phase_data::aero_phase_data_t::size

Get the number of species in the phase.

Definition at line 112 of file aero_phase_data.F90.

Member Data Documentation

◆ chem_spec_data

type(chem_spec_data_t), pointer camp_aero_phase_data::aero_phase_data_t::chem_spec_data

Pointer to the set of chemical species data.

Definition at line 103 of file aero_phase_data.F90.

◆ condensed_data_int

integer(kind=i_kind), dimension(:), allocatable, public camp_aero_phase_data::aero_phase_data_t::condensed_data_int

Condensed phase data. Theses arrays will be available during solving, and should contain any information required by the functions of the aerosol phase that cannot be obtained from the camp_camp_state::camp_state_t object. (integer)

Definition at line 101 of file aero_phase_data.F90.

◆ condensed_data_real

real(kind=dp), dimension(:), allocatable, public camp_aero_phase_data::aero_phase_data_t::condensed_data_real

Condensed phase data. Theses arrays will be available during solving, and should contain any information required by the functions of the aerosol phase that cannot be obtained from the camp_camp_state::camp_state_t object. (floating-point)

Definition at line 96 of file aero_phase_data.F90.

◆ num_spec

integer(kind=i_kind) camp_aero_phase_data::aero_phase_data_t::num_spec = 0

Number of species in the phase.

Definition at line 83 of file aero_phase_data.F90.

◆ phase_name

character(len=:), allocatable camp_aero_phase_data::aero_phase_data_t::phase_name
private

Name of the aerosol phase.

Definition at line 81 of file aero_phase_data.F90.

◆ property_set

type(property_t), pointer camp_aero_phase_data::aero_phase_data_t::property_set => null()

Aerosol phase parameters. These will be available during initialization, but not during solving.

Definition at line 91 of file aero_phase_data.F90.

◆ spec_name

type(string_t), dimension(:), pointer camp_aero_phase_data::aero_phase_data_t::spec_name => null()

Species names. These are species that are present in the aerosol phase. These species must exist in the camp_camp_core::camp_core_t::chem_spec_data variable during initialization.

Definition at line 88 of file aero_phase_data.F90.


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