commondata::sgr Interface Reference

Function for calculating specific growth rate. More...

Collaboration diagram for commondata::sgr:

Public Member Functions
elemental real(srp) function	sgr_r (weight1, weight2, time1, time2)
	Calculates specific growth rate following Houde & Schekter (1981): More...
elemental real(srp) function	sgr_i (weight1, weight2, time1, time2, time_unit)
	Calculates specific growth rate following Houde & Schekter (1981): More...
pure real(srp) function, dimension(:), allocatable	sgr_blockrate (inarray, rate_unit, time_unit)
	Calculate an array of specific growth rate rate values based on simple block data,. More...

Detailed Description

Function for calculating specific growth rate.

Definition at line 811 of file m_common.f90.

Member Function/Subroutine Documentation

sgr_r()

elemental real(srp) function commondata::sgr::sgr_r	(	real(srp), intent(in)	weight1,
		real(srp), intent(in)	weight2,
		real(srp), intent(in)	time1,
		real(srp), intent(in)	time2
	)

Calculates specific growth rate following Houde & Schekter (1981):

Note

Note that this function is the main computation backend that is called in sgr_i() and sgr_blockrate().

Parameters

[in]	weight1	Body weight at start of the time interval
[in]	weight2	Body weight at the end of the time interval
[in]	time1	Time at the start of the time interval
[in]	time2	Time at the end of the time interval

Definition at line 1942 of file m_common.f90.

sgr_i()

elemental real(srp) function commondata::sgr::sgr_i	(	real(srp), intent(in)	weight1,
		real(srp), intent(in)	weight2,
		integer, intent(in)	time1,
		integer, intent(in)	time2,
		integer, intent(in), optional	time_unit
	)

Calculates specific growth rate following Houde & Schekter (1981):

Note

Note that the is_convert_min (optional) parameter is useful to convert the time step data (s) to min.

Note that this function uses sgr_r() as the backend.

Parameters

[in]	weight1	Body weight at start of the time interval
[in]	weight2	Body weight at the end of the time interval
[in]	time1	Time at the start of the time interval
[in]	time2	Time at the end of the time interval
[in]	time_unit	If the two time parameters time1 and time2 are provided in raw model time units (s), this parameter allows to rescale these raw units to commondata::minute or commondata::hour.

Note

If time units are provided in any other measures than raw time steps (s), this time_unitparameter should be set to default value or out of normal range (e.g. -1). Then the rate unit will use the same time scale as time1 and time2. Notably, this should ber done if the times are given in commondata::hour.

Definition at line 1963 of file m_common.f90.

Here is the call graph for this function:

sgr_blockrate()

pure real(srp) function, dimension(:), allocatable commondata::sgr::sgr_blockrate	(	real(srp), dimension(:), intent(in)	inarray,
		integer, intent(in), optional	rate_unit,
		integer, intent(in), optional	time_unit
	)

Calculate an array of specific growth rate rate values based on simple block data,.

Note

This function is identical as blockrate() but uses specific growth rate calculated by sgr_i() function. In turn, sgr_i() uses sgr_r() as the backend.

Parameters

[in]	inarray	Input Output_Arrays array (real ::srp type)
[in]	rate_unit	Optional rate parameter, the rate is calculated per this number of seconds, the default is per minute
[in]	time_unit	Logical flag determining if time in s should be converted to min

Definition at line 1518 of file m_common.f90.

Here is the call graph for this function:

---

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

• m_common.f90 (16563)