PartMC  2.2.0
Data Types | Public Member Functions
pmc_env_data Module Reference

The env_data_t structure and associated subroutines. More...

List of all members.

Data Types

type  env_data_t
 Environment data. More...

Public Member Functions

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.
elemental logical function env_data_contains_aero_mode_type (env_data, aero_mode_type)
 Whether any of the contained aerosol modes are of the given type.
subroutine spec_file_read_env_data (file, gas_data, aero_data, env_data)
 Read environment data from an spec file.
integer function 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.

Definition at line 9 of file env_data.F90.


Member Function/Subroutine Documentation

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

Allocate an env_data.

Parameters:
[out]env_dataEnvironment data.

Definition at line 81 of file env_data.F90.

elemental logical function pmc_env_data::env_data_contains_aero_mode_type ( type(env_data_t), intent(in)  env_data,
integer, intent(in)  aero_mode_type 
)

Whether any of the contained aerosol modes are of the given type.

Parameters:
[in]env_dataEnvironment data.
[in]aero_mode_typeAerosol mode type to test for.

Definition at line 326 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:
[in]env_data_fromSource environment data.
[in,out]env_data_toDestination environment data.

Definition at line 159 of file env_data.F90.

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

Free all storage.

Parameters:
[in,out]env_dataEnvironment data.

Definition at line 113 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:
[in]env_dataEnvironment data.
[in,out]env_stateEnvironment state to update.
[in]timeCurrent time (s).

Definition at line 246 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:
[in]env_dataEnvironment data.
[in,out]env_stateEnvironment state to update.
[in]timeCurrent time (s).
[in]update_rel_humidWhether to update the relative humidity.

Definition at line 279 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:
[in,out]bufferMemory buffer.
[in,out]positionCurrent buffer position.
[in]valValue to pack.

Definition at line 555 of file env_data.F90.

integer function 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:
[in]valValue to pack.

Definition at line 511 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:
[in,out]bufferMemory buffer.
[in,out]positionCurrent buffer position.
[in,out]valValue to pack.

Definition at line 601 of file env_data.F90.

subroutine pmc_env_data::spec_file_read_env_data ( type(spec_file_t), intent(inout)  file,
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:
[in,out]fileSpec file.
[in]gas_dataGas data values.
[in,out]aero_dataAerosol data.
[in,out]env_dataEnvironment data.

Definition at line 345 of file env_data.F90.


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