GaussKronrodRule

class GaussKronrodRule(*args)

Gauss-Kronrod rule used in the integration algorithm.

Parameters
myGaussKronrodPairGaussKronrodPair

It encodes the selected rule.

Available rules:

  • GaussKronrodRule.G1K3,

  • GaussKronrodRule.G3K7,

  • GaussKronrodRule.G7K15,

  • GaussKronrodRule.G11K23,

  • GaussKronrodRule.G15K31,

  • GaussKronrodRule.G25K51.

Notes

The Gauss-Kronrod rules G_mK_{2m+1} with m=2n+1 enable to build two approximations of the definite integral \int_{-1}^1 f(t)\di{t} defined by:

\int_{-1}^1 f(t)\di{t} \simeq \omega_0f(0) + \sum_{k=1}^n \omega_k (f(\xi_k)+f(-\xi_k))

and:

\int_{-1}^1 f(t)\di{t}\simeq \alpha_0f(0) + \sum_{k=1}^{m} \alpha_k (f(\zeta_k)+f(-\zeta_k))

We have \xi_k>0, \zeta_k>0, \zeta_{2j}=\xi_j, \omega_k>0 and \alpha_k>0.

The rule G_mK_{2m+1} combines a m-point Gauss rule and a (2m+1)-point Kronrod rule (re-using the m nodes of the Gauss method). The nodes are defined on [-1, 1] and always contain the node 0 when m is odd.

Examples

Create an Gauss-Kronrod rule:

>>> import openturns as ot
>>> myRule = ot.GaussKronrodRule(ot.GaussKronrodRule.G15K31)

Methods

getClassName(self)

Accessor to the object’s name.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getOrder(self)

Accessor to m parameter.

getOtherGaussWeights(self)

Accessor to the weights used in the Gauss approximation.

getOtherKronrodNodes(self)

Accessor to the positive nodes used in the Gauss-Kronrod approximation.

getOtherKronrodWeights(self)

Accessor to the positive nodes used in the Gauss-Kronrod approximation.

getPair(self)

Accessor to pair definig the rule.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

getZeroGaussWeight(self)

Accessor to the first Gauss weight.

getZeroKronrodWeight(self)

Accessor to the first Kronrod weight.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setName(self, name)

Accessor to the object’s name.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.
__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns
namestr

The name of the object.

getOrder(self)

Accessor to m parameter.

Returns
mint

The number of points used for the Gauss approximation.

getOtherGaussWeights(self)

Accessor to the weights used in the Gauss approximation.

Returns
otherGaussWeightsPoint

The weights (\omega_k)_{1 \leq k \leq n}

getOtherKronrodNodes(self)

Accessor to the positive nodes used in the Gauss-Kronrod approximation.

Returns
otherKronrodNodesPoint

The positive nodes (\zeta_k)_{1 \leq k \leq m} It contains the positive Gauss nodes as we have \zeta_{2j}=\xi_j.

getOtherKronrodWeights(self)

Accessor to the positive nodes used in the Gauss-Kronrod approximation.

Returns
otherKronrodWeightsPoint

The weights (\alpha_k)_{1 \leq k \leq m}.

getPair(self)

Accessor to pair definig the rule.

Returns
gkPairGaussKronrodPair

Id of the Gauss-Kronrod rule.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

getZeroGaussWeight(self)

Accessor to the first Gauss weight.

Returns
zeroKronrodWeightfloat

The first weight \omega_0.

getZeroKronrodWeight(self)

Accessor to the first Kronrod weight.

Returns
zeroKronrodWeightfloat

The first weight \alpha_0.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.