The AHA Model  Revision: 12809
Reference implementation 04 (HEDG02_04)
the_environment::unjoin Interface Reference

An alias to the_environment::food_resources_update_back_global_object() method to transfer (having been modified) food resource objects out from the single united object back to the global array the_environment::global_habitats_available. See the_environment::join() for how to join an array of food resources into a single global object. More...

Collaboration diagram for the_environment::unjoin:

Public Member Functions

subroutine food_resources_update_back_global_object (food_resource_collapsed, reindex)
 Transfer the (having been modified) food resource objects from the single united object food_resource_collapsed back to the global array the_environment::global_habitats_available array. See the_environment::join() for how to join an array of food resources into a single global object. More...
 

Detailed Description

An alias to the_environment::food_resources_update_back_global_object() method to transfer (having been modified) food resource objects out from the single united object back to the global array the_environment::global_habitats_available. See the_environment::join() for how to join an array of food resources into a single global object.

Warning
Note that complete restoring the food resources back to each of the individual habitat objects out of the global array must be done using the the_environment::disassemble() procedure.

Definition at line 780 of file m_env.f90.

Member Function/Subroutine Documentation

◆ food_resources_update_back_global_object()

subroutine the_environment::unjoin::food_resources_update_back_global_object ( type(food_resource), intent(in)  food_resource_collapsed,
logical, intent(in), optional  reindex 
)

Transfer the (having been modified) food resource objects from the single united object food_resource_collapsed back to the global array the_environment::global_habitats_available array. See the_environment::join() for how to join an array of food resources into a single global object.

Parameters
[in]food_resource_collapsedA collapsed food resource previously joining the input array.
[in]reindexreindex logical flag to reindex the unjoined resource (TRUE) upon unjoining. The default is no reindexing.

Definition at line 8636 of file m_env.f90.


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