PartMC 2.1.0
Data Types | Functions/Subroutines | Variables
pmc_aero_info Module Reference

The aero_info_t structure and associated subroutines. More...

Data Types

type  aero_info_t
 Information about removed particles describing the sink. More...

Functions/Subroutines

subroutine aero_info_allocate (aero_info)
 Allocates and initializes.
subroutine aero_info_deallocate (aero_info)
 Deallocates.
subroutine aero_info_copy (aero_info_from, aero_info_to)
 Copies aero_info_from to aero_info_to, both of which must already be allocated.
subroutine aero_info_zero (aero_info)
 Resets an aero_info to contain zero particles.
integer pmc_mpi_pack_size_aero_info (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_aero_info (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_aero_info (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.

Variables

integer, parameter AERO_INFO_NONE = 0
 No information.
integer, parameter AERO_INFO_DILUTION = 1
 Particle was removed due to dilution with outside air.
integer, parameter AERO_INFO_COAG = 2
 Particle was removed due to coagulation.
integer, parameter AERO_INFO_HALVED = 3
 Particle was removed due to halving of the aerosol population.
integer, parameter AERO_INFO_WEIGHT = 4
 Particle was removed due to adjustments in the particle's weighting function.

Detailed Description

The aero_info_t structure and associated subroutines.


Function/Subroutine Documentation

subroutine pmc_aero_info::aero_info_allocate ( type(aero_info_t),intent(out)  aero_info)

Allocates and initializes.

Parameters:
aero_infoResult.
subroutine pmc_aero_info::aero_info_copy ( type(aero_info_t),intent(in)  aero_info_from,
type(aero_info_t),intent(inout)  aero_info_to 
)

Copies aero_info_from to aero_info_to, both of which must already be allocated.

Parameters:
aero_info_fromOrigin structure.
aero_info_toDestination structure.
subroutine pmc_aero_info::aero_info_deallocate ( type(aero_info_t),intent(inout)  aero_info)

Deallocates.

Parameters:
aero_infoStructure to deallocate.
subroutine pmc_aero_info::aero_info_zero ( type(aero_info_t),intent(inout)  aero_info)

Resets an aero_info to contain zero particles.

Parameters:
aero_infoStructure to reset.
subroutine pmc_aero_info::pmc_mpi_pack_aero_info ( character,dimension(:),intent(inout)  buffer,
integer,intent(inout)  position,
type(aero_info_t),intent(in)  val 
)

Packs the given value into the buffer, advancing position.

Parameters:
bufferMemory buffer.
positionCurrent buffer position.
valValue to pack.
integer pmc_aero_info::pmc_mpi_pack_size_aero_info ( type(aero_info_t),intent(in)  val)

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

Parameters:
valValue to pack.
subroutine pmc_aero_info::pmc_mpi_unpack_aero_info ( character,dimension(:),intent(inout)  buffer,
integer,intent(inout)  position,
type(aero_info_t),intent(inout)  val 
)

Unpacks the given value from the buffer, advancing position.

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

Variable Documentation

integer,parameter pmc_aero_info::AERO_INFO_COAG = 2

Particle was removed due to coagulation.

integer,parameter pmc_aero_info::AERO_INFO_DILUTION = 1

Particle was removed due to dilution with outside air.

integer,parameter pmc_aero_info::AERO_INFO_HALVED = 3

Particle was removed due to halving of the aerosol population.

integer,parameter pmc_aero_info::AERO_INFO_NONE = 0

No information.

integer,parameter pmc_aero_info::AERO_INFO_WEIGHT = 4

Particle was removed due to adjustments in the particle's weighting function.