pm_quadPack::wcos_type Interface Reference

This is the derived type for constructing objects that signify the computation of the integral of an arbitrary Cose-weighted function. More...

Public Attributes
real(RKH)	omega
	The scalar component of type real of kind RKH (the highest (precision) real kind available in the ParaMonte library, representing the frequency coefficient of the weight. More...

Detailed Description

This is the derived type for constructing objects that signify the computation of the integral of an arbitrary Cose-weighted function.

Return an object of type wcos_type containing the frequency of the Cose weight of a Fourier transform integration.

The specified weight via this derive type has the form,

\begin{equation} \cos(\omega x) ~, \end{equation}

that is used to signify the computation of the computation of the (Fourier transform) integral of the form:

\begin{equation} \int^{\ms{ub}}_{\ms{lb}} \cos(\omega x) f(x) dx \end{equation}

where \(\omega\) and \(f(x)\) are user-specified.

Objects of this derived type can be passed to the primary integrators of the parent modules of this derived type:

1. getQuadErr
   
2. isFailedQuad
   

Possible calling interfaces ⛓

use pm_quadPack, only: wcos_type
type(wcos_type) :: wcos_type
 
wcos = wcos_type(omega)

Remarks

The procedures under discussion are pure.

See also

getQuadErr.
isFailedQuad.

Test:

test_pm_quadPack

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Oct 16, 2009, 11:14 AM, Michigan

Developer Remark:

This generic interface exists because of the lack of support for PDTs in gfortran, requiring the derived type wcos_type to have omega component with the highest precision.

Parameters

[in]

omega

: The input scalar or array of arbitrary rank of type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), containing the angular frequency of the oscillatory Cosine weight in the integrand whose integral is to be computed.

Returns

wcos : The scalar or array of the same shape as omega of type Sin_type that uniquely determines the type and kind of the Cosine weight to be used in the integrand.

Possible calling interfaces ⛓

use pm_quadPack, only: wcos_type
type(wcos_type) :: wcos
 
wcos = wcos_type(omega)
print *, wcos%omega

Remarks

The procedures under discussion are pure.

See also

getQuadErr
isFailedQuad
wcos_type

Test:

test_pm_quadPack

Final Remarks ⛓

---

If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.

1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
   
2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.
   

This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.

Copyright

Computational Data Science Lab

Author:

Amir Shahmoradi, Oct 16, 2009, 11:14 AM, Michigan

Definition at line 497 of file pm_quadPack.F90.

Member Data Documentation

omega

real(RKH) pm_quadPack::wcos_type::omega

The scalar component of type real of kind RKH (the highest (precision) real kind available in the ParaMonte library, representing the frequency coefficient of the weight.

Definition at line 498 of file pm_quadPack.F90.

---

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

• src/fortran/main/pm_quadPack.F90