PartMC 2.1.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

subroutine aero_info_array_allocate (aero_info_array)
 Allocates the structure.
subroutine aero_info_array_allocate_size (aero_info_array, n_item)
 Allocates with the given size.
subroutine aero_info_array_deallocate (aero_info_array)
 Deallocates.
subroutine aero_info_array_copy (aero_info_array_from, aero_info_array_to)
 Copies aero_info_array_from to aero_info_array_to, both of which must already be allocated.
subroutine aero_info_array_zero (aero_info_array)
 Resets an aero_info_array to contain zero particles.
subroutine aero_info_array_realloc (aero_info_array, new_length)
 Changes the given aero_info_array to exactly the given new_length.
subroutine aero_info_array_enlarge (aero_info_array)
 Enlarges the given aero_info_array by at least one element.
subroutine aero_info_array_enlarge_to (aero_info_array, n)
 Enlarges the given array so that it is at least of size n.
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.
subroutine aero_info_array_add_aero_info (aero_info_array, aero_info)
 Adds the given aero_info to the end of the array.
subroutine aero_info_array_remove_aero_info (aero_info_array, index)
 Removes the aero_info at the given index.
subroutine aero_info_array_add (aero_info_array, aero_info_array_delta)
 Adds aero_info_array_delta to the end of aero_info_array.
integer pmc_mpi_pack_size_aia (val)
 Determines the number of bytes required to pack the given value.
subroutine pmc_mpi_pack_aero_info_array (buffer, position, val)
 Packs the given value into the buffer, advancing position.
subroutine pmc_mpi_unpack_aero_info_array (buffer, position, val)
 Unpacks the given value from the buffer, advancing position.

Detailed Description

The aero_info_array_t structure and assoicated subroutines.


Function/Subroutine Documentation

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:
aero_info_arrayArray to add to.
aero_info_array_deltaAero_info to add.
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:
aero_info_arrayArray to add to.
aero_infoAero_info to add.
subroutine pmc_aero_info_array::aero_info_array_allocate ( type(aero_info_array_t),intent(out)  aero_info_array)

Allocates the structure.

Parameters:
aero_info_arrayResult.
subroutine pmc_aero_info_array::aero_info_array_allocate_size ( type(aero_info_array_t),intent(out)  aero_info_array,
integer,intent(in)  n_item 
)

Allocates with the given size.

Parameters:
aero_info_arrayResult.
n_itemNumber of items.
subroutine pmc_aero_info_array::aero_info_array_copy ( type(aero_info_array_t),intent(in)  aero_info_array_from,
type(aero_info_array_t),intent(inout)  aero_info_array_to 
)

Copies aero_info_array_from to aero_info_array_to, both of which must already be allocated.

Parameters:
aero_info_array_fromOrigin structure.
aero_info_array_toDestination structure.
subroutine pmc_aero_info_array::aero_info_array_deallocate ( type(aero_info_array_t),intent(inout)  aero_info_array)

Deallocates.

Parameters:
aero_info_arrayStructure to deallocate.
subroutine pmc_aero_info_array::aero_info_array_enlarge ( type(aero_info_array_t),intent(inout)  aero_info_array)

Enlarges the given aero_info_array by at least one element.

Currently this doubles the length.

Parameters:
aero_info_arrayArray to enlarge.
subroutine pmc_aero_info_array::aero_info_array_enlarge_to ( type(aero_info_array_t),intent(inout)  aero_info_array,
integer,intent(in)  n 
)

Enlarges the given array so that it is at least of size n.

Parameters:
aero_info_arrayArray to enlarge.
nMinimum new size of array.
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:
aero_info_arrayArray to reallocate (must already be allocated on entry).
new_lengthNew length of the array.
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:
aero_info_arrayArray to remove from.
indexIndex of aero_info to remove.
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:
aero_info_arrayArray to shrink.
subroutine pmc_aero_info_array::aero_info_array_zero ( type(aero_info_array_t),intent(inout)  aero_info_array)

Resets an aero_info_array to contain zero particles.

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