FishMet: Fish feeding and appetite model, OPEN EDITION  0.1
FishMet: Fish feeding and appetite model, OPEN EDITION
commondata::cum2rate Interface Reference

Public interface for the cum2rate function that calculates rate from raw cumulative array. Note that rate unit time is defined by the integer rate_unit argument (as default, per commondata::minute). For details see cum2rate_int() and cum2rate_r(). More...

Collaboration diagram for commondata::cum2rate:

Public Member Functions

pure real(srp) function, dimension(:), allocatable cum2rate_int (inarray, rate_unit)
 Given an in put array of cumulative sum, this function calculates the rate per unit time defined by the rate_unit argument (as default, per commondata::minute). This requires working on the appropriate difference values for each time interval. Note: This function version accepts integer array. More...
 
pure real(srp) function, dimension(:), allocatable cum2rate_r (inarray, rate_unit)
 Given an in put array of cumulative sum, this function calculates the rate per unit time defined by the rate_unit argument (as default, per commondata::minute). This requires working on the appropriate difference values for each time interval. Note: This function version accepts real array (::srp). More...
 

Detailed Description

Public interface for the cum2rate function that calculates rate from raw cumulative array. Note that rate unit time is defined by the integer rate_unit argument (as default, per commondata::minute). For details see cum2rate_int() and cum2rate_r().

Definition at line 772 of file m_common.f90.

Member Function/Subroutine Documentation

◆ cum2rate_int()

pure real(srp) function, dimension(:), allocatable commondata::cum2rate::cum2rate_int ( integer, dimension(:), intent(in)  inarray,
integer, intent(in), optional  rate_unit 
)

Given an in put array of cumulative sum, this function calculates the rate per unit time defined by the rate_unit argument (as default, per commondata::minute). This requires working on the appropriate difference values for each time interval. Note: This function version accepts integer array.

Parameters
[in]inarrayInput Output_Arrays array (integer type)
[in]rate_unitOptional rate parameter, the rate is calculated per this number of seconds, the default is per minute

Definition at line 1395 of file m_common.f90.

◆ cum2rate_r()

pure real(srp) function, dimension(:), allocatable commondata::cum2rate::cum2rate_r ( real(srp), dimension(:), intent(in)  inarray,
integer, intent(in), optional  rate_unit 
)

Given an in put array of cumulative sum, this function calculates the rate per unit time defined by the rate_unit argument (as default, per commondata::minute). This requires working on the appropriate difference values for each time interval. Note: This function version accepts real array (::srp).

Parameters
[in]inarrayInput Output_Arrays array (real ::srp type)
[in]rate_unitOptional rate parameter, the rate is calculated per this number of seconds, the default is per minute

Definition at line 1436 of file m_common.f90.


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