PartMC  2.3.0
Data Types | Public Member Functions | List of all members
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...
 

Public Member Functions

subroutine aero_info_array_allocate (aero_info_array)
 Allocates the structure. More...
 
subroutine aero_info_array_allocate_size (aero_info_array, n_item)
 Allocates with the given size. More...
 
subroutine aero_info_array_deallocate (aero_info_array)
 Deallocates. More...
 
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. More...
 
subroutine aero_info_array_zero (aero_info_array)
 Resets an aero_info_array to contain zero particles. 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 (aero_info_array)
 Enlarges the given aero_info_array by at least one element. More...
 
subroutine aero_info_array_enlarge_to (aero_info_array, n)
 Enlarges the given array so 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.

Definition at line 9 of file aero_info_array.F90.

Member 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
[in,out]aero_info_arrayArray to add to.
[in]aero_info_array_deltaAero_info to add.

Definition at line 273 of file aero_info_array.F90.

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 225 of file aero_info_array.F90.

subroutine pmc_aero_info_array::aero_info_array_allocate ( type(aero_info_array_t), intent(out)  aero_info_array)

Allocates the structure.

Parameters
[out]aero_info_arrayResult.

Definition at line 48 of file aero_info_array.F90.

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
[out]aero_info_arrayResult.
[in]n_itemNumber of items.

Definition at line 63 of file aero_info_array.F90.

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
[in]aero_info_array_fromOrigin structure.
[in,out]aero_info_array_toDestination structure.

Definition at line 101 of file aero_info_array.F90.

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

Deallocates.

Parameters
[in,out]aero_info_arrayStructure to deallocate.

Definition at line 83 of file aero_info_array.F90.

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
[in,out]aero_info_arrayArray to enlarge.

Definition at line 171 of file aero_info_array.F90.

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
[in,out]aero_info_arrayArray to enlarge.
[in]nMinimum new size of array.

Definition at line 187 of file aero_info_array.F90.

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 143 of file aero_info_array.F90.

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 246 of file aero_info_array.F90.

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 204 of file aero_info_array.F90.

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
[in,out]aero_info_arrayStructure to reset.

Definition at line 124 of file aero_info_array.F90.

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 319 of file aero_info_array.F90.

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 299 of file aero_info_array.F90.

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 345 of file aero_info_array.F90.


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