PartMC  2.1.5
Data Types | Public Member Functions | Public Attributes
pmc_aero_weight Module Reference

The aero_weight_t structure and associated subroutines. More...

List of all members.

Data Types

type  aero_weight_t
 An aerosol size distribution weighting function. More...

Public Member Functions

subroutine aero_weight_allocate (aero_weight)
 Allocates an aero_weight.
subroutine aero_weight_allocate_size (aero_weight)
 Allocates an aero_weight of the given size.
subroutine aero_weight_deallocate (aero_weight)
 Free all storage.
subroutine aero_weight_zero (aero_weight)
 Zeros the contents of the aero_weight.
subroutine aero_weight_copy (aero_weight_from, aero_weight_to)
 Copy an aero_weight.
real(kind=dp) function aero_weight_value (aero_weight, radius)
 Give the value of an aero_weight at a specific radius.
subroutine spec_file_read_aero_weight (file, aero_weight)
 Read an aero_weight from a spec file.
integer function pmc_mpi_pack_size_aero_weight (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_aero_weight (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_aero_weight (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.
subroutine aero_weight_output_netcdf (aero_weight, ncid)
 Write full state.
subroutine aero_weight_input_netcdf (aero_weight, ncid)
 Read full state.

Public Attributes

integer, parameter AERO_WEIGHT_TYPE_INVALID = 0
 Type code for an undefined or invalid weighting.
integer, parameter AERO_WEIGHT_TYPE_NONE = 1
 Type code for no (or flat) weighting.
integer, parameter AERO_WEIGHT_TYPE_POWER = 2
 Type code for power function weighting.
integer, parameter AERO_WEIGHT_TYPE_MFA = 3
 Type code for MFA weighting.

Detailed Description

The aero_weight_t structure and associated subroutines.

Definition at line 9 of file aero_weight.F90.


Member Function/Subroutine Documentation

subroutine pmc_aero_weight::aero_weight_allocate ( type(aero_weight_t), intent(out)  aero_weight)

Allocates an aero_weight.

Parameters:
[out]aero_weightAerosol weight.

Definition at line 45 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_allocate_size ( type(aero_weight_t), intent(out)  aero_weight)

Allocates an aero_weight of the given size.

Parameters:
[out]aero_weightAerosol weight.

Definition at line 57 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_copy ( type(aero_weight_t), intent(in)  aero_weight_from,
type(aero_weight_t), intent(inout)  aero_weight_to 
)

Copy an aero_weight.

Parameters:
[in]aero_weight_fromAerosol weight original.
[in,out]aero_weight_toAerosol weight copy.

Definition at line 93 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_deallocate ( type(aero_weight_t), intent(in)  aero_weight)

Free all storage.

Parameters:
[in]aero_weightAerosol weight.

Definition at line 69 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_input_netcdf ( type(aero_weight_t), intent(inout)  aero_weight,
integer, intent(in)  ncid 
)

Read full state.

Parameters:
[in,out]aero_weightEnvironment state to read.
[in]ncidNetCDF file ID, in data mode.

Definition at line 295 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_output_netcdf ( type(aero_weight_t), intent(in)  aero_weight,
integer, intent(in)  ncid 
)

Write full state.

Parameters:
[in]aero_weightAero weight to write.
[in]ncidNetCDF file ID, in data mode.

Definition at line 259 of file aero_weight.F90.

real(kind=dp) function pmc_aero_weight::aero_weight_value ( type(aero_weight_t), intent(in)  aero_weight,
real(kind=dp), intent(in)  radius 
)

Give the value of an aero_weight at a specific radius.

Parameters:
[in]aero_weightAerosol weight.
[in]radiusRadius to compute weight at (m).

Definition at line 109 of file aero_weight.F90.

subroutine pmc_aero_weight::aero_weight_zero ( type(aero_weight_t), intent(inout)  aero_weight)

Zeros the contents of the aero_weight.

Parameters:
[in,out]aero_weightAerosol weight.

Definition at line 79 of file aero_weight.F90.

subroutine pmc_aero_weight::pmc_mpi_pack_aero_weight ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_weight_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 209 of file aero_weight.F90.

integer function pmc_aero_weight::pmc_mpi_pack_size_aero_weight ( type(aero_weight_t), intent(in)  val)

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

Parameters:
[in]valValue to pack.

Definition at line 194 of file aero_weight.F90.

subroutine pmc_aero_weight::pmc_mpi_unpack_aero_weight ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_weight_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 234 of file aero_weight.F90.

subroutine pmc_aero_weight::spec_file_read_aero_weight ( type(spec_file_t), intent(inout)  file,
type(aero_weight_t), intent(inout)  aero_weight 
)

Read an aero_weight from a spec file.

Parameters:
[in,out]fileSpec file.
[in,out]aero_weightAerosol weight.

Definition at line 132 of file aero_weight.F90.


Member Data Documentation

Type code for an undefined or invalid weighting.

Definition at line 22 of file aero_weight.F90.

integer, parameter pmc_aero_weight::AERO_WEIGHT_TYPE_MFA = 3

Type code for MFA weighting.

Definition at line 28 of file aero_weight.F90.

Type code for no (or flat) weighting.

Definition at line 24 of file aero_weight.F90.

Type code for power function weighting.

Definition at line 26 of file aero_weight.F90.


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