PartMC 2.1.2
Data Types | Functions/Subroutines
pmc_env_data Module Reference

The env_data_t structure and associated subroutines. More...

Data Types

type  env_data_t
 Environment data. More...

Functions/Subroutines

subroutine env_data_allocate (env_data)
 Allocate an env_data.
subroutine env_data_deallocate (env_data)
 Free all storage.
subroutine env_data_copy (env_data_from, env_data_to)
 Copy structure.
subroutine env_data_init_state (env_data, env_state, time)
 Initialize the time-dependent contents of the environment. Thereafter env_data_update_state() should be used.
subroutine env_data_update_state (env_data, env_state, time, update_rel_humid)
 Update time-dependent contents of the environment. env_data_init_state() should have been called at the start.
subroutine spec_file_read_env_data (file, bin_grid, gas_data, aero_data, env_data)
 Read environment data from an spec file.
integer pmc_mpi_pack_size_env_data (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_env_data (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_env_data (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.

Detailed Description

The env_data_t structure and associated subroutines.


Function/Subroutine Documentation

subroutine pmc_env_data::env_data_allocate ( type(env_data_t),intent(out)  env_data)

Allocate an env_data.

Parameters:
env_dataEnvironment data.

Definition at line 82 of file env_data.F90.

subroutine pmc_env_data::env_data_copy ( type(env_data_t),intent(in)  env_data_from,
type(env_data_t),intent(inout)  env_data_to 
)

Copy structure.

Parameters:
env_data_fromSource environment data.
env_data_toDestination environment data.

Definition at line 160 of file env_data.F90.

subroutine pmc_env_data::env_data_deallocate ( type(env_data_t),intent(inout)  env_data)

Free all storage.

Parameters:
env_dataEnvironment data.

Definition at line 114 of file env_data.F90.

subroutine pmc_env_data::env_data_init_state ( type(env_data_t),intent(in)  env_data,
type(env_state_t),intent(inout)  env_state,
real(kind=dp),intent(in)  time 
)

Initialize the time-dependent contents of the environment. Thereafter env_data_update_state() should be used.

Parameters:
env_dataEnvironment data.
env_stateEnvironment state to update.
timeCurrent time (s).

Definition at line 247 of file env_data.F90.

subroutine pmc_env_data::env_data_update_state ( type(env_data_t),intent(in)  env_data,
type(env_state_t),intent(inout)  env_state,
real(kind=dp),intent(in)  time,
logical,intent(in)  update_rel_humid 
)

Update time-dependent contents of the environment. env_data_init_state() should have been called at the start.

Parameters:
env_dataEnvironment data.
env_stateEnvironment state to update.
timeCurrent time (s).
update_rel_humidWhether to update the relative humidity.

Definition at line 280 of file env_data.F90.

subroutine pmc_env_data::pmc_mpi_pack_env_data ( character,dimension(:),intent(inout)  buffer,
integer,intent(inout)  position,
type(env_data_t),intent(in)  val 
)

Packs the given value into the buffer, advancing position.

Parameters:
bufferMemory buffer.
positionCurrent buffer position.
valValue to pack.

Definition at line 540 of file env_data.F90.

integer pmc_env_data::pmc_mpi_pack_size_env_data ( type(env_data_t),intent(in)  val)

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

Parameters:
valValue to pack.

Definition at line 496 of file env_data.F90.

subroutine pmc_env_data::pmc_mpi_unpack_env_data ( character,dimension(:),intent(inout)  buffer,
integer,intent(inout)  position,
type(env_data_t),intent(inout)  val 
)

Unpacks the given value from the buffer, advancing position.

Parameters:
bufferMemory buffer.
positionCurrent buffer position.
valValue to pack.

Definition at line 586 of file env_data.F90.

subroutine pmc_env_data::spec_file_read_env_data ( type(spec_file_t),intent(inout)  file,
type(bin_grid_t),intent(in)  bin_grid,
type(gas_data_t),intent(in)  gas_data,
type(aero_data_t),intent(inout)  aero_data,
type(env_data_t),intent(inout)  env_data 
)

Read environment data from an spec file.

Parameters:
fileSpec file.
bin_gridBin grid.
gas_dataGas data values.
aero_dataAerosol data.
env_dataEnvironment data.

Definition at line 327 of file env_data.F90.