PartMC 2.1.4
Data Types | Functions/Subroutines | Variables
pmc_gas_data Module Reference

The gas_data_t structure and associated subroutines. More...

Data Types

type  gas_data_t
 Constant gas data. More...

Functions/Subroutines

subroutine gas_data_allocate (gas_data)
 Allocate storage for gas species.
subroutine gas_data_allocate_size (gas_data, n_spec)
 Allocate storage for gas species with the given size.
subroutine gas_data_deallocate (gas_data)
 Free all storage.
integer 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.
subroutine gas_data_set_mosaic_map (gas_data)
 Fills in gas_datamosaic_index.
subroutine spec_file_read_gas_data (file, gas_data)
 Read gas data from a .spec file.
integer pmc_mpi_pack_size_gas_data (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_gas_data (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_gas_data (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.
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.
subroutine gas_data_output_netcdf (gas_data, ncid)
 Write full state.
subroutine gas_data_input_netcdf (gas_data, ncid)
 Read full state.

Variables

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

Detailed Description

The gas_data_t structure and associated subroutines.


Function/Subroutine Documentation

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

Allocate storage for gas species.

Parameters:
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:
gas_dataGas data.
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:
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:
gas_dataGas_data to read.
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:
gas_dataGas_data structure.
ncidNetCDF file ID, in data mode.
dimid_gas_speciesDimid of the species dimension.

Definition at line 296 of file gas_data.F90.

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

Write full state.

Parameters:
gas_dataGas_data to write.
ncidNetCDF file ID, in data mode.

Definition at line 350 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_datamosaic_index.

Parameters:
gas_dataGas data.

Definition at line 117 of file gas_data.F90.

integer 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:
gas_dataGas data.
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:
bufferMemory buffer.
positionCurrent buffer position.
valValue to pack.

Definition at line 244 of file gas_data.F90.

integer 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:
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:
bufferMemory buffer.
positionCurrent buffer position.
valValue to pack.

Definition at line 269 of file gas_data.F90.

subroutine pmc_gas_data::spec_file_read_gas_data ( type(spec_file_t),intent(inout)  file,
type(gas_data_t),intent(inout)  gas_data 
)

Read gas data from a .spec file.

Parameters:
fileSpec file to read data from.
gas_dataGas data.

Definition at line 172 of file gas_data.F90.


Variable 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.