This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays. More...

Public Member Functions
real(siki) function	interpwrappedstpreal4 (XValIn, XAry, YAry, Ind, AryLen)
	This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays. More...

real(r8ki) function	interpwrappedstpreal4_8 (XValIn, XAry, YAry, Ind, AryLen)
	This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays. More...

real(r8ki) function	interpwrappedstpreal8 (XValIn, XAry, YAry, Ind, AryLen)
	This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays. More...

real(quki) function	interpwrappedstpreal16 (XValIn, XAry, YAry, Ind, AryLen)
	This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays. More...

Detailed Description

This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays.

It is assumed that XAry is sorted in ascending order. It uses the passed index as the starting point and does a stepwise interpolation from there. This is especially useful when the calling routines save the value from the last time this routine was called for a given case where XVal does not change much from call to call. When there is no correlation from one interpolation to another, InterpBin() may be a better choice. It returns the first or last YAry() value if XVal is outside the limits of XAry().

Use InterpWrappedStpReal (nwtc_num::interpwrappedstpreal) instead of directly calling a specific routine in the generic interface.

Returns: The interpolated value of Y at XVal

Parameters

[in]	arylen	Length of the arrays.
[in,out]	ind	Initial and final index into the arrays.
[in]	xary	Array of X values to be interpolated.
[in]	xvalin	X value to be interpolated.
[in]	yary	Array of Y values to be interpolated.

Member Function/Subroutine Documentation

◆ interpwrappedstpreal16()

real(quki) function nwtc_num::interpwrappedstpreal::interpwrappedstpreal16	(	real(quki), intent(in)	XValIn,
		real(quki), dimension (arylen), intent(in)	XAry,
		real(quki), dimension (arylen), intent(in)	YAry,
		integer, intent(inout)	Ind,
		integer, intent(in)	AryLen
	)

This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays.

It is assumed that XAry is sorted in ascending order. It uses the passed index as the starting point and does a stepwise interpolation from there. This is especially useful when the calling routines save the value from the last time this routine was called for a given case where XVal does not change much from call to call. When there is no correlation from one interpolation to another, InterpBin() may be a better choice. It returns the first or last YAry() value if XVal is outside the limits of XAry().

Use InterpWrappedStpReal (nwtc_num::interpwrappedstpreal) instead of directly calling a specific routine in the generic interface.

Returns: The interpolated value of Y at XVal

Parameters

[in]	arylen	Length of the arrays.
[in,out]	ind	Initial and final index into the arrays.
[in]	xary	Array of X values to be interpolated.
[in]	xvalin	X value to be interpolated.
[in]	yary	Array of Y values to be interpolated.

Returns: The interpolated value of Y at XVal

Parameters

[in] arylen Length of the arrays.

◆ interpwrappedstpreal4()

real(siki) function nwtc_num::interpwrappedstpreal::interpwrappedstpreal4	(	real(siki), intent(in)	XValIn,
		real(siki), dimension (arylen), intent(in)	XAry,
		real(siki), dimension (arylen), intent(in)	YAry,
		integer, intent(inout)	Ind,
		integer, intent(in)	AryLen
	)

This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays.

It is assumed that XAry is sorted in ascending order. It uses the passed index as the starting point and does a stepwise interpolation from there. This is especially useful when the calling routines save the value from the last time this routine was called for a given case where XVal does not change much from call to call. When there is no correlation from one interpolation to another, InterpBin() may be a better choice. It returns the first or last YAry() value if XVal is outside the limits of XAry().

Use InterpWrappedStpReal (nwtc_num::interpwrappedstpreal) instead of directly calling a specific routine in the generic interface.

Returns: The interpolated value of Y at XVal

Parameters

[in]	arylen	Length of the arrays.
[in,out]	ind	Initial and final index into the arrays.
[in]	xary	Array of X values to be interpolated.
[in]	xvalin	X value to be interpolated.
[in]	yary	Array of Y values to be interpolated.

◆ interpwrappedstpreal4_8()

real(r8ki) function nwtc_num::interpwrappedstpreal::interpwrappedstpreal4_8	(	real(siki), intent(in)	XValIn,
		real(siki), dimension (arylen), intent(in)	XAry,
		real(r8ki), dimension (arylen), intent(in)	YAry,
		integer, intent(inout)	Ind,
		integer, intent(in)	AryLen
	)

This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays.

It is assumed that XAry is sorted in ascending order. It uses the passed index as the starting point and does a stepwise interpolation from there. This is especially useful when the calling routines save the value from the last time this routine was called for a given case where XVal does not change much from call to call. When there is no correlation from one interpolation to another, InterpBin() may be a better choice. It returns the first or last YAry() value if XVal is outside the limits of XAry().

Use InterpWrappedStpReal (nwtc_num::interpwrappedstpreal) instead of directly calling a specific routine in the generic interface.

Returns: The interpolated value of Y at XVal

Parameters

[in]	arylen	Length of the arrays.
[in,out]	ind	Initial and final index into the arrays.
[in]	xary	Array of X values to be interpolated.
[in]	xvalin	X value to be interpolated.
[in]	yary	Array of Y values to be interpolated.

Returns: The interpolated value of Y at XVal

◆ interpwrappedstpreal8()

real(r8ki) function nwtc_num::interpwrappedstpreal::interpwrappedstpreal8	(	real(r8ki), intent(in)	XValIn,
		real(r8ki), dimension (arylen), intent(in)	XAry,
		real(r8ki), dimension (arylen), intent(in)	YAry,
		integer, intent(inout)	Ind,
		integer, intent(in)	AryLen
	)

This funtion returns a y-value that corresponds to an input x-value which is wrapped back into the range [0-XAry(AryLen)] by interpolating into the arrays.

It is assumed that XAry is sorted in ascending order. It uses the passed index as the starting point and does a stepwise interpolation from there. This is especially useful when the calling routines save the value from the last time this routine was called for a given case where XVal does not change much from call to call. When there is no correlation from one interpolation to another, InterpBin() may be a better choice. It returns the first or last YAry() value if XVal is outside the limits of XAry().

Use InterpWrappedStpReal (nwtc_num::interpwrappedstpreal) instead of directly calling a specific routine in the generic interface.

Returns: The interpolated value of Y at XVal

Parameters

[in]	arylen	Length of the arrays.
[in,out]	ind	Initial and final index into the arrays.
[in]	xary	Array of X values to be interpolated.
[in]	xvalin	X value to be interpolated.
[in]	yary	Array of Y values to be interpolated.

Returns: The interpolated value of Y at XVal

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

NWTC_Num.f90

Public Member Functions

Detailed Description

Member Function/Subroutine Documentation

◆ interpwrappedstpreal16()

◆ interpwrappedstpreal4()

◆ interpwrappedstpreal4_8()

◆ interpwrappedstpreal8()