PartMC  2.6.1
Data Types | Functions/Subroutines
pmc_aero_info_array Module Reference

The aero_info_array_t structure and assoicated subroutines. More...

Data Types

type  aero_info_array_t
 1-D arrays of aero_info_t structure. More...
 

Functions/Subroutines

elemental integer function aero_info_array_n_item (aero_info_array)
 Return the current number of items. More...
 
subroutine aero_info_array_zero (aero_info_array)
 Sets an aero_info_array to contain zero data. More...
 
subroutine aero_info_array_realloc (aero_info_array, new_length)
 Changes the given aero_info_array to exactly the given new_length. More...
 
subroutine aero_info_array_enlarge_to (aero_info_array, n)
 Possibly enlarges the given array, ensuring that it is at least of size n. More...
 
subroutine aero_info_array_shrink (aero_info_array)
 Possibly shrinks the storage of the given array, ensuring that it can still store the allocated particles. More...
 
subroutine aero_info_array_add_aero_info (aero_info_array, aero_info)
 Adds the given aero_info to the end of the array. More...
 
subroutine aero_info_array_remove_aero_info (aero_info_array, index)
 Removes the aero_info at the given index. More...
 
subroutine aero_info_array_add (aero_info_array, aero_info_array_delta)
 Adds aero_info_array_delta to the end of aero_info_array. More...
 
integer function pmc_mpi_pack_size_aia (val)
 Determines the number of bytes required to pack the given value. More...
 
subroutine pmc_mpi_pack_aero_info_array (buffer, position, val)
 Packs the given value into the buffer, advancing position. More...
 
subroutine pmc_mpi_unpack_aero_info_array (buffer, position, val)
 Unpacks the given value from the buffer, advancing position. More...
 

Detailed Description

The aero_info_array_t structure and assoicated subroutines.

Function/Subroutine Documentation

◆ aero_info_array_add()

subroutine pmc_aero_info_array::aero_info_array_add ( type(aero_info_array_t), intent(inout)  aero_info_array,
type(aero_info_array_t), intent(in)  aero_info_array_delta 
)

Adds aero_info_array_delta to the end of aero_info_array.

Parameters
[in,out]aero_info_arrayArray to add to.
[in]aero_info_array_deltaAero_info to add.

Definition at line 196 of file aero_info_array.F90.

◆ aero_info_array_add_aero_info()

subroutine pmc_aero_info_array::aero_info_array_add_aero_info ( type(aero_info_array_t), intent(inout)  aero_info_array,
type(aero_info_t), intent(in)  aero_info 
)

Adds the given aero_info to the end of the array.

Parameters
[in,out]aero_info_arrayArray to add to.
[in]aero_infoAero_info to add.

Definition at line 152 of file aero_info_array.F90.

◆ aero_info_array_enlarge_to()

subroutine pmc_aero_info_array::aero_info_array_enlarge_to ( type(aero_info_array_t), intent(inout)  aero_info_array,
integer, intent(in)  n 
)

Possibly enlarges the given array, ensuring that it is at least of size n.

Parameters
[in,out]aero_info_arrayArray to enlarge.
[in]nMinimum new size of array.

Definition at line 111 of file aero_info_array.F90.

◆ aero_info_array_n_item()

elemental integer function pmc_aero_info_array::aero_info_array_n_item ( type(aero_info_array_t), intent(in)  aero_info_array)

Return the current number of items.

Parameters
[in]aero_info_arrayAero info array.

Definition at line 46 of file aero_info_array.F90.

◆ aero_info_array_realloc()

subroutine pmc_aero_info_array::aero_info_array_realloc ( type(aero_info_array_t), intent(inout)  aero_info_array,
integer, intent(in)  new_length 
)

Changes the given aero_info_array to exactly the given new_length.

This function should not be called directly, but rather use aero_info_array_enlarge(), aero_info_array_enlarge_to() or aero_info_array_shrink().

Parameters
[in,out]aero_info_arrayArray to reallocate (must already be allocated on entry).
[in]new_lengthNew length of the array.

Definition at line 83 of file aero_info_array.F90.

◆ aero_info_array_remove_aero_info()

subroutine pmc_aero_info_array::aero_info_array_remove_aero_info ( type(aero_info_array_t), intent(inout)  aero_info_array,
integer, intent(in)  index 
)

Removes the aero_info at the given index.

Parameters
[in,out]aero_info_arrayArray to remove from.
[in]indexIndex of aero_info to remove.

Definition at line 172 of file aero_info_array.F90.

◆ aero_info_array_shrink()

subroutine pmc_aero_info_array::aero_info_array_shrink ( type(aero_info_array_t), intent(inout)  aero_info_array)

Possibly shrinks the storage of the given array, ensuring that it can still store the allocated particles.

Parameters
[in,out]aero_info_arrayArray to shrink.

Definition at line 133 of file aero_info_array.F90.

◆ aero_info_array_zero()

subroutine pmc_aero_info_array::aero_info_array_zero ( type(aero_info_array_t), intent(inout)  aero_info_array)

Sets an aero_info_array to contain zero data.

Parameters
[in,out]aero_info_arrayStructure to reset.

Definition at line 62 of file aero_info_array.F90.

◆ pmc_mpi_pack_aero_info_array()

subroutine pmc_aero_info_array::pmc_mpi_pack_aero_info_array ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_info_array_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 241 of file aero_info_array.F90.

◆ pmc_mpi_pack_size_aia()

integer function pmc_aero_info_array::pmc_mpi_pack_size_aia ( type(aero_info_array_t), intent(in)  val)

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

Parameters
[in]valValue to pack.

Definition at line 220 of file aero_info_array.F90.

◆ pmc_mpi_unpack_aero_info_array()

subroutine pmc_aero_info_array::pmc_mpi_unpack_aero_info_array ( character, dimension(:), intent(inout)  buffer,
integer, intent(inout)  position,
type(aero_info_array_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 267 of file aero_info_array.F90.