pmc_gas_data Namespace Reference

The gas_data_t structure and associated subroutines. More...

Classes

struct  gas_data_t
 Constant gas data. More...

Functions

subroutine gas_data_alloc (gas_data, n_spec)
 Allocate storage for gas species.
subroutine gas_data_free (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 inout_write_gas_data (file, gas_data)
 Write full state.
subroutine inout_read_gas_data (file, gas_data)
 Read full state.
subroutine spec_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.

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 Documentation

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

Allocate storage for gas species.

Parameters:
gas_data Gas data.
n_spec Number of species.
subroutine pmc_gas_data::gas_data_free ( type(gas_data_t),intent(out)  gas_data  ) 

Free all storage.

Parameters:
gas_data Gas data.
subroutine pmc_gas_data::gas_data_set_mosaic_map ( type(gas_data_t),intent(inout)  gas_data  ) 

Fills in gas_datamosaic_index.

Parameters:
gas_data Gas data.
integer pmc_gas_data::gas_data_spec_by_name ( type(gas_data_t),intent(in)  gas_data,
character(len=GAS_NAME_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_data Gas data.
name Name of species to find.
subroutine pmc_gas_data::inout_read_gas_data ( type(inout_file_t),intent(inout)  file,
type(gas_data_t),intent(out)  gas_data 
)

Read full state.

Parameters:
file File to read from.
gas_data Gas_data to read.
subroutine pmc_gas_data::inout_write_gas_data ( type(inout_file_t),intent(inout)  file,
type(gas_data_t),intent(in)  gas_data 
)

Write full state.

Parameters:
file File to write to.
gas_data Gas_data to write.
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:
buffer Memory buffer.
position Current buffer position.
val Value to pack.
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:
val Value to pack.
subroutine pmc_gas_data::pmc_mpi_unpack_gas_data ( character,dimension(:),intent(inout)  buffer,
integer,intent(inout)  position,
type(gas_data_t),intent(out)  val 
)

Unpacks the given value from the buffer, advancing position.

Parameters:
buffer Memory buffer.
position Current buffer position.
val Value to pack.
subroutine pmc_gas_data::spec_read_gas_data ( type(inout_file_t),intent(inout)  file,
type(gas_data_t),intent(out)  gas_data 
)

Read gas data from a .spec file.

Parameters:
file Spec file.
gas_data Gas data.

Variable Documentation

integer,parameter pmc_gas_data::GAS_NAME_LEN = 100

Maximum length of the name of a gas.


Generated on 29 Mar 2010 for PartMC by  doxygen 1.6.1