PartMC  2.2.0
Data Types | Public Member Functions | Public Attributes
pmc_aero_data Module Reference

The aero_data_t structure and associated subroutines. More...

List of all members.

Data Types

type  aero_data_t
 Aerosol material properties and associated data. More...

Public Member Functions

subroutine aero_data_allocate (aero_data)
 Allocate storage for aero_data.
subroutine aero_data_allocate_size (aero_data, n_spec, n_source)
 Allocate storage for aero_data parameters given the number of species.
subroutine aero_data_deallocate (aero_data)
 Frees all storage.
subroutine aero_data_copy (aero_data_from, aero_data_to)
 Copy structure.
integer function aero_data_spec_by_name (aero_data, name)
 Returns the number of the species in aero_data with the given name, or returns 0 if there is no such species.
integer function aero_data_source_by_name (aero_data, name)
 Returns the number of the source in aero_data with the given name, or adds the source if it doesn't exist yet.
subroutine aero_data_set_water_index (aero_data)
 Fills in aero_datai_water.
subroutine aero_data_set_mosaic_map (aero_data)
 Fills in aero_datamosaic_index.
subroutine spec_file_read_aero_data (file, aero_data)
 Read aero_data specification from a spec file.
subroutine spec_file_read_species_list (file, name, aero_data, species_list)
 Read a list of species from the given file with the given name.
integer function pmc_mpi_pack_size_aero_data (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_aero_data (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_aero_data (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.
subroutine aero_data_netcdf_dim_aero_species (aero_data, ncid, dimid_aero_species)
 Write the aero species dimension to the given NetCDF file if it is not already present and in any case return the associated dimid.
subroutine aero_data_netcdf_dim_aero_source (aero_data, ncid, dimid_aero_source)
 Write the aero source dimension to the given NetCDF file if it is not already present and in any case return the associated dimid.
subroutine aero_data_output_netcdf (aero_data, ncid)
 Write full state.
subroutine aero_data_input_netcdf (aero_data, ncid)
 Read full state.

Public Attributes

integer, parameter AERO_NAME_LEN = 15
integer, parameter AERO_SOURCE_NAME_LEN = 100

Detailed Description

The aero_data_t structure and associated subroutines.

Definition at line 9 of file aero_data.F90.


Member Function/Subroutine Documentation

subroutine pmc_aero_data::aero_data_allocate ( type(aero_data_t), intent(out)  aero_data)

Allocate storage for aero_data.

Parameters:
[out]aero_dataAerosol data.

Definition at line 69 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_allocate_size ( type(aero_data_t), intent(out)  aero_data,
integer, intent(in)  n_spec,
integer, intent(in)  n_source 
)

Allocate storage for aero_data parameters given the number of species.

Parameters:
[out]aero_dataAerosol data.
[in]n_specNumber of species.
[in]n_sourceNumber of sources.

Definition at line 91 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_copy ( type(aero_data_t), intent(in)  aero_data_from,
type(aero_data_t), intent(inout)  aero_data_to 
)

Copy structure.

Parameters:
[in]aero_data_fromSource aerosol data.
[in,out]aero_data_toDestination aerosol data.

Definition at line 134 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_deallocate ( type(aero_data_t), intent(inout)  aero_data)

Frees all storage.

Parameters:
[in,out]aero_dataAerosol data.

Definition at line 116 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_input_netcdf ( type(aero_data_t), intent(inout)  aero_data,
integer, intent(in)  ncid 
)

Read full state.

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

Definition at line 664 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_netcdf_dim_aero_source ( type(aero_data_t), intent(in)  aero_data,
integer, intent(in)  ncid,
integer, intent(out)  dimid_aero_source 
)

Write the aero source dimension to the given NetCDF file if it is not already present and in any case return the associated dimid.

Parameters:
[in]aero_dataAero_data structure.
[in]ncidNetCDF file ID, in data mode.
[out]dimid_aero_sourceDimid of the source dimension.

Definition at line 547 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_netcdf_dim_aero_species ( type(aero_data_t), intent(in)  aero_data,
integer, intent(in)  ncid,
integer, intent(out)  dimid_aero_species 
)

Write the aero species dimension to the given NetCDF file if it is not already present and in any case return the associated dimid.

Parameters:
[in]aero_dataAero_data structure.
[in]ncidNetCDF file ID, in data mode.
[out]dimid_aero_speciesDimid of the species dimension.

Definition at line 491 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_output_netcdf ( type(aero_data_t), intent(in)  aero_data,
integer, intent(in)  ncid 
)

Write full state.

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

Definition at line 602 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_set_mosaic_map ( type(aero_data_t), intent(inout)  aero_data)

Fills in aero_datamosaic_index.

Parameters:
[in,out]aero_dataAero_data data.

Definition at line 244 of file aero_data.F90.

subroutine pmc_aero_data::aero_data_set_water_index ( type(aero_data_t), intent(inout)  aero_data)

Fills in aero_datai_water.

Parameters:
[in,out]aero_dataAero_data data.

Definition at line 226 of file aero_data.F90.

integer function pmc_aero_data::aero_data_source_by_name ( type(aero_data_t), intent(inout)  aero_data,
character(len=*), intent(in)  name 
)

Returns the number of the source in aero_data with the given name, or adds the source if it doesn't exist yet.

Parameters:
[in,out]aero_dataAero_data data.
[in]nameName of source to find.

Definition at line 189 of file aero_data.F90.

integer function pmc_aero_data::aero_data_spec_by_name ( type(aero_data_t), intent(in)  aero_data,
character(len=*), intent(in)  name 
)

Returns the number of the species in aero_data with the given name, or returns 0 if there is no such species.

Parameters:
[in]aero_dataAero_data data.
[in]nameName of species to find.

Definition at line 160 of file aero_data.F90.

subroutine pmc_aero_data::pmc_mpi_pack_aero_data ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_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 425 of file aero_data.F90.

integer function pmc_aero_data::pmc_mpi_pack_size_aero_data ( type(aero_data_t), intent(in)  val)

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

Parameters:
[in]valValue to pack.

Definition at line 403 of file aero_data.F90.

subroutine pmc_aero_data::pmc_mpi_unpack_aero_data ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_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 457 of file aero_data.F90.

subroutine pmc_aero_data::spec_file_read_aero_data ( type(spec_file_t), intent(inout)  file,
type(aero_data_t), intent(inout)  aero_data 
)

Read aero_data specification from a spec file.

Parameters:
[in,out]fileSpec file to read data from.
[in,out]aero_dataAero_data data.

Definition at line 277 of file aero_data.F90.

subroutine pmc_aero_data::spec_file_read_species_list ( type(spec_file_t), intent(inout)  file,
character(len=*), intent(in)  name,
type(aero_data_t), intent(in)  aero_data,
integer, dimension(:), pointer  species_list 
)

Read a list of species from the given file with the given name.

Parameters:
[in,out]fileSpec file.
[in]nameName of line.
[in]aero_dataAero_data data.
species_listList of species numbers.

Definition at line 371 of file aero_data.F90.


Member Data Documentation

integer, parameter pmc_aero_data::AERO_NAME_LEN = 15

Definition at line 19 of file aero_data.F90.

integer, parameter pmc_aero_data::AERO_SOURCE_NAME_LEN = 100

Definition at line 20 of file aero_data.F90.


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