PartMC  2.3.0
Data Types | Public Member Functions | Public Attributes | List of all members
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...
 

Public Member Functions

subroutine aero_info_allocate (aero_info)
 Allocates and initializes. More...
 
subroutine aero_info_deallocate (aero_info)
 Deallocates. More...
 
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. More...
 
subroutine aero_info_zero (aero_info)
 Resets an aero_info to contain zero particles. More...
 
integer function pmc_mpi_pack_size_aero_info (val)
 Determines the number of bytes required to pack the given value. More...
 
subroutine pmc_mpi_pack_aero_info (buffer, position, val)
 Packs the given value into the buffer, advancing position. More...
 
subroutine pmc_mpi_unpack_aero_info (buffer, position, val)
 Unpacks the given value from the buffer, advancing position. More...
 

Public Attributes

integer, parameter aero_info_none = 0
 No information. More...
 
integer, parameter aero_info_dilution = 1
 Particle was removed due to dilution with outside air. More...
 
integer, parameter aero_info_coag = 2
 Particle was removed due to coagulation. More...
 
integer, parameter aero_info_halved = 3
 Particle was removed due to halving of the aerosol population. More...
 
integer, parameter aero_info_weight = 4
 Particle was removed due to adjustments in the particle's weighting function. More...
 

Detailed Description

The aero_info_t structure and associated subroutines.

Definition at line 9 of file aero_info.F90.

Member Function/Subroutine Documentation

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

Allocates and initializes.

Parameters
[out]aero_infoResult.

Definition at line 63 of file aero_info.F90.

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
[in]aero_info_fromOrigin structure.
[in,out]aero_info_toDestination structure.

Definition at line 86 of file aero_info.F90.

subroutine pmc_aero_info::aero_info_deallocate ( type(aero_info_t), intent(inout)  aero_info)

Deallocates.

Parameters
[in,out]aero_infoStructure to deallocate.

Definition at line 75 of file aero_info.F90.

subroutine pmc_aero_info::aero_info_zero ( type(aero_info_t), intent(inout)  aero_info)

Resets an aero_info to contain zero particles.

Parameters
[in,out]aero_infoStructure to reset.

Definition at line 103 of file aero_info.F90.

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

Definition at line 135 of file aero_info.F90.

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

Definition at line 117 of file aero_info.F90.

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

Definition at line 160 of file aero_info.F90.

Member Data Documentation

integer, parameter pmc_aero_info::aero_info_coag = 2

Particle was removed due to coagulation.

Definition at line 23 of file aero_info.F90.

integer, parameter pmc_aero_info::aero_info_dilution = 1

Particle was removed due to dilution with outside air.

Definition at line 21 of file aero_info.F90.

integer, parameter pmc_aero_info::aero_info_halved = 3

Particle was removed due to halving of the aerosol population.

Definition at line 25 of file aero_info.F90.

integer, parameter pmc_aero_info::aero_info_none = 0

No information.

Definition at line 19 of file aero_info.F90.

integer, parameter pmc_aero_info::aero_info_weight = 4

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

Definition at line 28 of file aero_info.F90.


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