PartMC  2.3.0
Data Types | Public Member Functions | Public Attributes | List of all members
pmc_gas_data Module Reference

The gas_data_t structure and associated subroutines. More...

Data Types

type  gas_data_t
 Constant gas data. More...
 

Public Member Functions

subroutine gas_data_allocate (gas_data)
 Allocate storage for gas species. More...
 
subroutine gas_data_allocate_size (gas_data, n_spec)
 Allocate storage for gas species with the given size. More...
 
subroutine gas_data_deallocate (gas_data)
 Free all storage. More...
 
integer function gas_data_spec_by_name (gas_data, name)
 Returns the number of the species in gas with the given name, or returns 0 if there is no such species. More...
 
subroutine gas_data_set_mosaic_map (gas_data)
 Fills in gas_data%mosaic_index. More...
 
integer function pmc_mpi_pack_size_gas_data (val)
 Determines the number of bytes required to pack the given value. More...
 
subroutine pmc_mpi_pack_gas_data (buffer, position, val)
 Packs the given value into the buffer, advancing position. More...
 
subroutine pmc_mpi_unpack_gas_data (buffer, position, val)
 Unpacks the given value from the buffer, advancing position. More...
 
subroutine gas_data_netcdf_dim_gas_species (gas_data, ncid, dimid_gas_species)
 Write the gas species dimension to the given NetCDF file if it is not already present and in any case return the associated dimid. More...
 
subroutine gas_data_input_netcdf (gas_data, ncid)
 Read full state. More...
 

Public Attributes

integer, parameter gas_name_len = 100
 Maximum length of the name of a gas. More...
 

Detailed Description

The gas_data_t structure and associated subroutines.

Definition at line 9 of file gas_data.F90.

Member Function/Subroutine Documentation

subroutine pmc_gas_data::gas_data_allocate ( type(gas_data_t), intent(out)  gas_data)

Allocate storage for gas species.

Parameters
[out]gas_dataGas data.

Definition at line 45 of file gas_data.F90.

subroutine pmc_gas_data::gas_data_allocate_size ( type(gas_data_t), intent(out)  gas_data,
integer, intent(in)  n_spec 
)

Allocate storage for gas species with the given size.

Parameters
[out]gas_dataGas data.
[in]n_specNumber of species.

Definition at line 59 of file gas_data.F90.

subroutine pmc_gas_data::gas_data_deallocate ( type(gas_data_t), intent(inout)  gas_data)

Free all storage.

Parameters
[in,out]gas_dataGas data.

Definition at line 75 of file gas_data.F90.

subroutine pmc_gas_data::gas_data_input_netcdf ( type(gas_data_t), intent(inout)  gas_data,
integer, intent(in)  ncid 
)

Read full state.

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

Definition at line 386 of file gas_data.F90.

subroutine pmc_gas_data::gas_data_netcdf_dim_gas_species ( type(gas_data_t), intent(in)  gas_data,
integer, intent(in)  ncid,
integer, intent(out)  dimid_gas_species 
)

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

Parameters
[in]gas_dataGas_data structure.
[in]ncidNetCDF file ID, in data mode.
[out]dimid_gas_speciesDimid of the species dimension.

Definition at line 296 of file gas_data.F90.

subroutine pmc_gas_data::gas_data_set_mosaic_map ( type(gas_data_t), intent(inout)  gas_data)

Fills in gas_data%mosaic_index.

Parameters
[in,out]gas_dataGas data.

Definition at line 117 of file gas_data.F90.

integer function pmc_gas_data::gas_data_spec_by_name ( type(gas_data_t), intent(in)  gas_data,
character(len=*), intent(in)  name 
)

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

Parameters
[in]gas_dataGas data.
[in]nameName of species to find.

Definition at line 89 of file gas_data.F90.

subroutine pmc_gas_data::pmc_mpi_pack_gas_data ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(gas_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 244 of file gas_data.F90.

integer function pmc_gas_data::pmc_mpi_pack_size_gas_data ( type(gas_data_t), intent(in)  val)

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

Parameters
[in]valValue to pack.

Definition at line 229 of file gas_data.F90.

subroutine pmc_gas_data::pmc_mpi_unpack_gas_data ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(gas_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 269 of file gas_data.F90.

Member Data Documentation

integer, parameter pmc_gas_data::gas_name_len = 100

Maximum length of the name of a gas.

Definition at line 20 of file gas_data.F90.


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