The env_state_t structure and associated subroutines. More...
Data Types | |
| type | env_state_t |
| Current environment state. More... | |
Functions/Subroutines | |
| subroutine | env_state_add (env_state, env_state_delta) |
| env_state += env_state_delta More... | |
| subroutine | env_state_scale (env_state, alpha) |
| env_state *= alpha More... | |
| subroutine | env_state_change_water_volume (env_state, dv) |
| Adds the given water volume to the water vapor and updates all environment quantities. More... | |
| real(kind=dp) function | env_state_sat_vapor_pressure (env_state) |
| Computes the current saturation vapor pressure (Pa). More... | |
| real(kind=dp) function | env_state_air_den (env_state) |
| Air density (kg m^{-3}). More... | |
| real(kind=dp) function | env_state_air_molar_den (env_state) |
| Air molar density (mol m^{-3}). More... | |
| real(kind=dp) function | env_state_rel_humid_to_mix_rat (env_state) |
| Converts relative humidity (1) to water vapor mixing ratio (ppb). More... | |
| real(kind=dp) function | env_state_a (env_state) |
Condensation  parameter. More... | |
| real(kind=dp) function | env_state_ppb_to_conc (env_state, ppb) |
| Convert (ppb) to (molecules m^{-3}). More... | |
| real(kind=dp) function | env_state_conc_to_ppb (env_state, conc) |
| Convert (molecules m^{-3}) to (ppb). More... | |
| subroutine | env_state_mix (val) |
| Average val over all processes. More... | |
| subroutine | env_state_reduce_avg (val) |
| Average val over all processes, with the result only on the root process. More... | |
| integer function | pmc_mpi_pack_size_env_state (val) |
| Determines the number of bytes required to pack the given value. More... | |
| subroutine | pmc_mpi_pack_env_state (buffer, position, val) |
| Packs the given value into the buffer, advancing position. More... | |
| subroutine | pmc_mpi_unpack_env_state (buffer, position, val) |
| Unpacks the given value from the buffer, advancing position. More... | |
| subroutine | pmc_mpi_reduce_avg_env_state (val, val_avg) |
| Computes the average of val across all processes, storing the result in val_avg on the root process. More... | |
| subroutine | env_state_input_netcdf (env_state, ncid) |
| Read full state. More... | |
Detailed Description
The env_state_t structure and associated subroutines.
Function/Subroutine Documentation
◆ env_state_a()
| real(kind=dp) function pmc_env_state::env_state_a | ( | type(env_state_t), intent(in) | env_state | ) |
Condensation parameter.
- Parameters
-
[in] env_state Environment state.
Definition at line 227 of file env_state.F90.
◆ env_state_add()
| subroutine pmc_env_state::env_state_add | ( | type(env_state_t), intent(inout) | env_state, |
| type(env_state_t), intent(in) | env_state_delta | ||
| ) |
env_state += env_state_delta
- Parameters
-
[in,out] env_state Environment. [in] env_state_delta Increment.
Definition at line 85 of file env_state.F90.
◆ env_state_air_den()
| real(kind=dp) function pmc_env_state::env_state_air_den | ( | type(env_state_t), intent(in) | env_state | ) |
Air density (kg m^{-3}).
- Parameters
-
[in] env_state Environment state.
Definition at line 179 of file env_state.F90.
◆ env_state_air_molar_den()
| real(kind=dp) function pmc_env_state::env_state_air_molar_den | ( | type(env_state_t), intent(in) | env_state | ) |
Air molar density (mol m^{-3}).
- Parameters
-
[in] env_state Environment state.
Definition at line 192 of file env_state.F90.
◆ env_state_change_water_volume()
| subroutine pmc_env_state::env_state_change_water_volume | ( | type(env_state_t), intent(inout) | env_state, |
| real(kind=dp), intent(in) | dv | ||
| ) |
Adds the given water volume to the water vapor and updates all environment quantities.
- Parameters
-
[in,out] env_state Environment state to update. [in] dv Volume concentration of water added (m^3/m^3).
Definition at line 136 of file env_state.F90.
◆ env_state_conc_to_ppb()
| real(kind=dp) function pmc_env_state::env_state_conc_to_ppb | ( | type(env_state_t), intent(in) | env_state, |
| real(kind=dp), intent(in) | conc | ||
| ) |
Convert (molecules m^{-3}) to (ppb).
- Parameters
-
[in] env_state Environment state. [in] conc Concentration (molecules m^{-3}).
Definition at line 255 of file env_state.F90.
◆ env_state_input_netcdf()
| subroutine pmc_env_state::env_state_input_netcdf | ( | type(env_state_t), intent(inout) | env_state, |
| integer, intent(in) | ncid | ||
| ) |
Read full state.
- Parameters
-
[in,out] env_state Environment state to read. [in] ncid NetCDF file ID, in data mode.
Definition at line 612 of file env_state.F90.
◆ env_state_mix()
| subroutine pmc_env_state::env_state_mix | ( | type(env_state_t), intent(inout) | val | ) |
Average val over all processes.
- Parameters
-
[in,out] val Value to average.
Definition at line 338 of file env_state.F90.
◆ env_state_ppb_to_conc()
| real(kind=dp) function pmc_env_state::env_state_ppb_to_conc | ( | type(env_state_t), intent(in) | env_state, |
| real(kind=dp), intent(in) | ppb | ||
| ) |
Convert (ppb) to (molecules m^{-3}).
- Parameters
-
[in] env_state Environment state. [in] ppb Mixing ratio (ppb).
Definition at line 240 of file env_state.F90.
◆ env_state_reduce_avg()
| subroutine pmc_env_state::env_state_reduce_avg | ( | type(env_state_t), intent(inout) | val | ) |
Average val over all processes, with the result only on the root process.
- Parameters
-
[in,out] val Value to average.
Definition at line 360 of file env_state.F90.
◆ env_state_rel_humid_to_mix_rat()
| real(kind=dp) function pmc_env_state::env_state_rel_humid_to_mix_rat | ( | type(env_state_t), intent(in) | env_state | ) |
Converts relative humidity (1) to water vapor mixing ratio (ppb).
Uses equation (1.10) of Seinfeld and Pandis Atmospheric Chemistry and Physics From Air Pollution to Climate Change Second Edition, 2006.
- Parameters
-
[in] env_state Environment state.
Definition at line 208 of file env_state.F90.
◆ env_state_sat_vapor_pressure()
| real(kind=dp) function pmc_env_state::env_state_sat_vapor_pressure | ( | type(env_state_t), intent(in) | env_state | ) |
Computes the current saturation vapor pressure (Pa).
- Parameters
-
[in] env_state Environment state.
Definition at line 165 of file env_state.F90.
◆ env_state_scale()
| subroutine pmc_env_state::env_state_scale | ( | type(env_state_t), intent(inout) | env_state, |
| real(kind=dp), intent(in) | alpha | ||
| ) |
env_state *= alpha
- Parameters
-
[in,out] env_state Environment. [in] alpha Scale factor.
Definition at line 111 of file env_state.F90.
◆ pmc_mpi_pack_env_state()
| subroutine pmc_env_state::pmc_mpi_pack_env_state | ( | character, dimension(:), intent(inout) | buffer, |
| integer, intent(inout) | position, | ||
| type(env_state_t), intent(in) | val | ||
| ) |
Packs the given value into the buffer, advancing position.
- Parameters
-
[in,out] buffer Memory buffer. [in,out] position Current buffer position. [in] val Value to pack.
Definition at line 420 of file env_state.F90.
◆ pmc_mpi_pack_size_env_state()
| integer function pmc_env_state::pmc_mpi_pack_size_env_state | ( | type(env_state_t), intent(in) | val | ) |
Determines the number of bytes required to pack the given value.
- Parameters
-
[in] val Value to pack.
Definition at line 383 of file env_state.F90.
◆ pmc_mpi_reduce_avg_env_state()
| subroutine pmc_env_state::pmc_mpi_reduce_avg_env_state | ( | type(env_state_t), intent(in) | val, |
| type(env_state_t), intent(inout) | val_avg | ||
| ) |
Computes the average of val across all processes, storing the result in val_avg on the root process.
- Parameters
-
[in] val Value to average. [in,out] val_avg Result.
Definition at line 516 of file env_state.F90.
◆ pmc_mpi_unpack_env_state()
| subroutine pmc_env_state::pmc_mpi_unpack_env_state | ( | character, dimension(:), intent(inout) | buffer, |
| integer, intent(inout) | position, | ||
| type(env_state_t), intent(inout) | val | ||
| ) |
Unpacks the given value from the buffer, advancing position.
- Parameters
-
[in,out] buffer Memory buffer. [in,out] position Current buffer position. [in,out] val Value to pack.
Definition at line 467 of file env_state.F90.