Package pulse.problem.schemes.rte.exact

Class NewtonCotesQuadrature

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

pulse.math.AbstractIntegrator

pulse.problem.schemes.rte.exact.CompositionProduct

pulse.problem.schemes.rte.exact.NewtonCotesQuadrature

All Implemented Interfaces:

Serializable, Descriptive, Reflexive

public class NewtonCotesQuadrature
extends CompositionProduct

A class for evaluating the composition product using a simple Newton-Cotes quadrature with a cutoff.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
NewtonCotesQuadrature()	Constructs a default NewtonCotesQuadrature with integration bounds spanning from 0 to 1.
NewtonCotesQuadrature(Segment bounds)	Constructs a default NewtonCotesQuadrature whose integration bounds are specified by the argument.
NewtonCotesQuadrature(Segment bounds, NumericProperty segments)	Constructs a custom NewtonCotesQuadrature with specified integration bounds and number of integration segments.

Method Summary

Modifier and Type	Method	Description
NumericProperty	getCutoff()
FixedIntervalIntegrator	getIntegrator()	This will retrieve the Newton-Cotes integrator, which by default is the Simpson integrator.
boolean	ignoreSiblings()	Should Accessibles that belong to this PropertyHolder be ignored when this PropertyHolder is displayed in a table?
double	integrate()	Uses the Newton-Cotes integrator (by default, the Simpson's rule) to evaluate the composition product.
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
void	set(NumericPropertyKeyword type, NumericProperty property)	An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible.
void	setCutoff(NumericProperty cutoff)
String	toString()

Methods inherited from class pulse.problem.schemes.rte.exact.CompositionProduct

getAlpha, getBeta, getEmissionFunction, getOrder, getPrefix, integrand, setCoefficients, setEmissionFunction, setOrder

Methods inherited from class pulse.math.AbstractIntegrator

getBounds, setBounds

Methods inherited from class pulse.util.PropertyHolder

addListener, areDetailsHidden, data, describe, firePropertyChanged, getDescriptor, getListeners, initListeners, isListedNumericType, isListedParameter, listedTypes, numericData, parameterListChanged, removeListeners, setPrefix, updateProperties, updateProperty

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NewtonCotesQuadrature

public NewtonCotesQuadrature()

Constructs a default NewtonCotesQuadrature with integration bounds spanning from 0 to 1.

NewtonCotesQuadrature

public NewtonCotesQuadrature(Segment bounds)

Constructs a default NewtonCotesQuadrature whose integration bounds are specified by the argument.

Parameters:

bounds - the integration bounds

NewtonCotesQuadrature

public NewtonCotesQuadrature(Segment bounds,
                             NumericProperty segments)

Constructs a custom NewtonCotesQuadrature with specified integration bounds and number of integration segments. The underlying integration scheme by default is a SimpsonIntegrator.

Parameters:

bounds - the integration bounds

segments - the number of integration segments. The higher this number, the higher is the accuracy.

See Also:

SimpsonIntegrator

Method Detail

integrate

public double integrate()

Uses the Newton-Cotes integrator (by default, the Simpson's rule) to evaluate the composition product.

Specified by:

integrate in class AbstractIntegrator

Returns:

the value of the integral

getIntegrator

public FixedIntervalIntegrator getIntegrator()

This will retrieve the Newton-Cotes integrator, which by default is the Simpson integrator.

Returns:

the integrator

toString

public String toString()

Overrides:

toString in class Object

getCutoff

public NumericProperty getCutoff()

setCutoff

public void setCutoff(NumericProperty cutoff)

set

public void set(NumericPropertyKeyword type,
                NumericProperty property)

Description copied from class: Accessible

An abstract method, which must be overriden to gain access over setting the values of all relevant (selected by the programmer) NumericProperties in subclasses of Accessible. Typically this involves a switch statement that goes through the different options for the type and invokes different set(...) methods to update the matching NumericProperty with property.

Specified by:

set in class Accessible

Parameters:

type - the type, which must be equal by definition to property.getType().

property - the property, which contains new information.

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

Description copied from class: PropertyHolder

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

Overrides:

listedKeywords in class PropertyHolder

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

ignoreSiblings

public boolean ignoreSiblings()

Description copied from class: PropertyHolder

Should Accessibles that belong to this PropertyHolder be ignored when this PropertyHolder is displayed in a table?

Overrides:

ignoreSiblings in class PropertyHolder

Returns:

false by default

See Also:

PropertyHolderTable