commondata::within Interface Reference

Force a value within the range set by the vmin and vmax dummy parameter values. More...

Collaboration diagram for commondata::within:

Public Member Functions
elemental integer function	within_i (value_in, vmin, vmax)
	Force a value within the range set by the vmin and vmax dummy parameter values. If the value is within the range, it does not change, if it falls outside, the output force value is obtained as min( max( value, FORCE_MIN ), FORCE_MAX ) More...
elemental real(srp) function	within_r (value_in, vmin, vmax)
	Force a value within the range set by the vmin and vmax dummy parameter values. If the value is within the range, it does not change, if it falls outside, the output force value is obtained as min( max( value, FORCE_MIN ), FORCE_MAX ) More...

Detailed Description

Force a value within the range set by the vmin and vmax dummy parameter values.

Definition at line 819 of file m_common.f90.

Member Function/Subroutine Documentation

within_i()

elemental integer function commondata::within::within_i	(	integer, intent(in)	value_in,
		integer, intent(in), optional	vmin,
		integer, intent(in)	vmax
	)

Force a value within the range set by the vmin and vmax dummy parameter values. If the value is within the range, it does not change, if it falls outside, the output force value is obtained as min( max( value, FORCE_MIN ), FORCE_MAX )

Parameters

[in]	value_in	Input value for forcing transformation.
[in]	vmin	minimum value of the force-to range (lower limit), if not present, a lower limit of 0.0 is used.
[in]	vmax	maximum value of the force-to range (upper limit)

Returns

an input value forced to the range.

Note

Note that this is the integer version of the generic within function.

Definition at line 1758 of file m_common.f90.

within_r()

elemental real(srp) function commondata::within::within_r	(	real(srp), intent(in)	value_in,
		real(srp), intent(in), optional	vmin,
		real(srp), intent(in)	vmax
	)

Force a value within the range set by the vmin and vmax dummy parameter values. If the value is within the range, it does not change, if it falls outside, the output force value is obtained as min( max( value, FORCE_MIN ), FORCE_MAX )

Parameters

[in]	value_in	Input value for forcing transformation.
[in]	vmin	minimum value of the force-to range (lower limit), if not present, a lower limit of 0.0 is used.
[in]	vmax	maximum value of the force-to range (upper limit)

Returns

an input value forced to the range.

Note

Note that this is the real precision version of the generic within function.

Definition at line 1726 of file m_common.f90.

---

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

• m_common.f90 (16563)