CCPP SciDoc v7.0.0  v7.0.0
Common Community Physics Package Developed at DTC
 
Loading...
Searching...
No Matches
mo_gas_concentrations Module Reference

Values may be provided as scalars, 1-dimensional profiles (nlay), or 2-D fields (ncol,nlay). nlay and ncol are determined from the input arrays; self-consistency is enforced. No bounds are enforced on the sum of the mixing ratios. More...

Data Types

type  conc_field
 
type  ty_gas_concs
 

Functions/Subroutines

character(len=128) function init (this, gas_names)
 
character(len=128) function set_vmr_scalar (this, gas, w)
 
character(len=128) function set_vmr_1d (this, gas, w)
 
character(len=128) function set_vmr_2d (this, gas, w)
 
character(len=128) function get_vmr_1d (this, gas, array)
 
character(len=128) function get_vmr_2d (this, gas, array)
 
character(len=128) function get_subset_range (this, start, n, subset)
 Extract a subset of n columns starting with column start
 
subroutine reset (this)
 Free memory and reset the object to an unititialzed state.
 
pure integer function get_num_gases (this)
 Inquire function - how many gases are known? (Not all concentrations need be set)
 
pure character(len=32) function, dimension(this%get_num_gases()) get_gas_names (this)
 Inquire function - what are the names of the known gases? (Not all concentrations need be set)
 
integer function find_gas (this, gas)
 
subroutine del (this)
 Finalization - free all memory when the object goes out of scope.
 

Variables

integer, parameter, private gas_not_in_list = -1
 

Detailed Description

Fortran class for representing gas concentrations

Encapsulates a collection of volume (molar) mixing ratios (concentrations) of gases. Each concentration is associated with a name, normally the chemical formula.

For example:

error_msg = gas_concs%set_vmr('h2o', values(:,:))
error_msg = gas_concs%set_vmr('o3' , values(:) )
error_msg = gas_concs%set_vmr('co2', value )

Values can be requested as profiles (valid only if there are no 2D fields present in the object) or as 2D fields. Values for all columns are returned although the entire collection can be subsetted in the column dimension

Subsets can be extracted in the column dimension.

Functions return strings. Non-empty strings indicate an error.