decodes.tsdb.algo.EstimatedInflow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opendcs Show documentation
A collection of software for aggregatting and processing environmental data such as from NOAA GOES satellites.
The newest version!
package decodes.tsdb.algo;

import decodes.tsdb.DbCompException;
import ilex.var.NamedVariable;

import org.opendcs.annotations.algorithm.Algorithm;
import org.opendcs.annotations.algorithm.Input;
import org.opendcs.annotations.algorithm.Output;

import java.util.Date;

@Algorithm(description = "Estimate inflow over the interval from reservoir storage and outflow.\n" +
		"Estimated Inflow = delta(Storage) + AverageOutflow over period.\n" +
		"Inputs are: Storage (in cubic meters), and outflow (in cubic meters per second)\n" +
		"Output is estimated inflow (in cubic meters per second)")
public class EstimatedInflow
	extends decodes.tsdb.algo.AW_AlgorithmBase
{
	@Input
	public double storage;
	@Input
	public double outflow;

	double store_t0 = 0.;
	double store_t1 = 0.;
	double out_t0 = 0.;
	double out_t1 = 0.;
	boolean firstInPeriod = true;
	int numSlices = 0;
	Date first = null;
	Date last = null;


    @Output
	public NamedVariable inflow = new NamedVariable("inflow", 0);

	@org.opendcs.annotations.PropertySpec(value="true")
	public boolean aggUpperBoundClosed = true;
	@org.opendcs.annotations.PropertySpec(value="true")
	public boolean aggLowerBoundClosed = true;

	// Allow javac to generate a no-args constructor.

	/**
	 * Algorithm-specific initialization provided by the subclass.
	 */
	protected void initAWAlgorithm( )
		throws DbCompException
	{
		_awAlgoType = AWAlgoType.AGGREGATING;
		_aggPeriodVarRoleName = "inflow";
	}
	
	/**
	 * This method is called once before iterating all time slices.
	 */
	protected void beforeTimeSlices()
		throws DbCompException
	{
		firstInPeriod = true;
		numSlices = 0;
		first = null;
		last = null;
	}

	/**
	 * Do the algorithm for a single time slice.
	 * AW will fill in user-supplied code here.
	 * Base class will set inputs prior to calling this method.
	 * User code should call one of the setOutput methods for a time-slice
	 * output variable.
	 *
	 * @throws DbCompException (or subclass thereof) if execution of this
	 *        algorithm is to be aborted.
	 */
	protected void doAWTimeSlice()
		throws DbCompException
	{
		numSlices++;
		if (firstInPeriod)
		{
			store_t0 = storage;
			out_t0 = outflow;
			first = _timeSliceBaseTime;
			firstInPeriod = false;
		}
		else
		{
			store_t1 = storage;
			out_t1 = outflow;
			last = _timeSliceBaseTime;
		}
	}

	/**
	 * This method is called once after iterating all time slices.
	 */
	protected void afterTimeSlices()
		throws DbCompException
	{
		if (numSlices >= 2)
		{
			// Determine # of seconds in the aggregate period
			long seconds = (last.getTime() - first.getTime())
				/ 1000L;
debug3("Period Start=" + first
+ ", Period End=" + last
+ ", elapsed seconds = " + seconds);
debug3("First Sample at " + first + ", storage=" + store_t0 + ", outflow=" + out_t0);
debug3(" Last Sample at " + last  + ", storage=" + store_t1 + ", outflow=" + out_t1);
			// Get delta-storage (cubic meters):
			double dStore = (store_t1 - store_t0);
			// Convert output discharge Q to volume over period
			// (cubic meters / sec ===> cubic meters)
			// Then take the average from the start to end of period.
			double ave_out = .5 * (out_t0*seconds + out_t1*seconds);
debug3("change in storage is " + dStore
+ ", average outflow over period is " + ave_out);
			// Add in the storage, and convert to meters per second.
			double volume = dStore + ave_out;
			double discharge = volume / seconds;
			
			// Output the estimated inflow in cubic meters.
			setOutput(inflow, discharge);
		}
	}

}