net.agmodel.weatherData
Interface SolarRadiation

All Superinterfaces:

CompoundSequence, MetSequence, Sequence

All Known Implementing Classes:

SolarRadiationImpl

public interface SolarRadiation

extends MetSequence

Interface to a solar radiation sequence which can store several kinds of solar radiation.
The different kinds of radiation are accessed using the constants in RadiationKind as indices Radiation is commonly measured either as an instantaneous value or as an integral over time. Our approach is to return the instantaneous value (W/m2) from all get methods except getTotal, which returns the integral in MJ/m2. The exception is the instantaneous value of PPFD, which is returned in µmol s-1m-2. (A similar convention is used with Wind)

Method Summary

JigsawQuantity	getAverage(RadiationKind kind, Interval interval) Returns the average solar radiation over the interval.
JigsawQuantity	getInstant(RadiationKind kind, Date time) Returns the instantaneous solar radiation at a particular point in time.
JigsawQuantity	getMaximum(RadiationKind kind, Interval interval) Returns the maximum solar radiation over the interval.
JigsawQuantity	getMinimum(RadiationKind kind, Interval interval) Returns the minimum solar radiation over the interval.
JigsawQuantity	getTotal(RadiationKind kind, Interval interval) Returns the accumulated solar energy over the interval in MJ/m2.
boolean	hasKind(RadiationKind kind) Returns true if the specified kind of radiation is available

Methods inherited from interface net.agmodel.weatherData.MetSequence

getSequenceElement, summarize

Methods inherited from interface net.agmodel.physical.CompoundSequence

cancelTemporalInterpolation, getAllCoverage, getAllData, getCoverage, getData, getMaximumTemporalInterpolation, getSubHeading, getTemporalInterpolation, getUnitsHeading, setSequenceHeading, setSubHeading, setTemporalInterpolation, setUnitsHeading

Methods inherited from interface net.agmodel.physical.Sequence

clone, dumpSequence, getColumnHeading, getContentsAsString, getCurrentResolution, getDateRange, getName, getNumberOfSubComponents, getResolution, getSequenceHeading, getSubHeading, getSummaryKind, getUnitsHeading, setColumnHeading, setName

Method Detail

hasKind

public boolean hasKind(RadiationKind kind)

Returns true if the specified kind of radiation is available

Parameters:

kind - a constant corresponding to the type of solar radiation

getMinimum

public JigsawQuantity getMinimum(RadiationKind kind,
                                 Interval interval)

Returns the minimum solar radiation over the interval. Sequence values at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Parameters:

kind - a constant corresponding to the type of solar radiation

Returns:

the minimum value (W/m2)

getMaximum

public JigsawQuantity getMaximum(RadiationKind kind,
                                 Interval interval)

Returns the maximum solar radiation over the interval. Sequence values at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Parameters:

kind - a constant corresponding to the type of solar radiation

Returns:

the maximum value (W/m2)

getInstant

public JigsawQuantity getInstant(RadiationKind kind,
                                 Date time)

Returns the instantaneous solar radiation at a particular point in time. If interpolation is requested, the value may be spatially and/or temporally interpolated from other data.

Parameters:

kind - a constant corresponding to the type of solar radiation

Returns:

the instantaneous value (W/m2)

getAverage

public JigsawQuantity getAverage(RadiationKind kind,
                                 Interval interval)

Returns the average solar radiation over the interval. Sequence values at either end of the interval are included by weighting their values according to the proportion of their duration that lies in the period of interest.

Parameters:

kind - a constant corresponding to the type of solar radiation

Returns:

the average value (W/m2)

getTotal

public JigsawQuantity getTotal(RadiationKind kind,
                               Interval interval)

Returns the accumulated solar energy over the interval in MJ/m2. Sequence values at either end of the interval are included by weighting their values according to the proportion of their duration that lies in the period of interest.

Parameters:

kind - a constant corresponding to the type of solar radiation

Returns:

the total value in MJ/m2