decodes.hdb.algo.SideInflowAlg 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.hdb.algo;

import java.util.Date;

import ilex.var.NamedVariableList;
import ilex.var.NamedVariable;
import decodes.tsdb.DbAlgorithmExecutive;
import decodes.tsdb.DbCompException;
import decodes.tsdb.DbIoException;
import decodes.tsdb.VarFlags;
// this new import was added by M. Bogner Aug 2012 for the 3.0 CP upgrade project
import decodes.tsdb.algo.AWAlgoType;

//AW:IMPORTS
import decodes.hdb.HdbFlags;

//AW:IMPORTS_END

//AW:JAVADOC
/**
This algorithm is an Side Inflow mass balance calculation for inflow as:  
Delta Storage - Total Release Above + Total Release Below + evaporation 

If inputs Delta Storage or Total Release Above or Total Release Below
or  ithe Evap do not exist or have been deleted and the 
Delta_STORAGE_MISSING or the TOTAL_REL_ABOVE_MISSING or EVAP_MISSING,
or TOTAL_REL_BELOW_MISSING properties are set to "fail" then the 
inflow will not be calculated and/or the inflow will be deleted.

If all of the inputs do not exist because of a delete the inflow will 
be deleted if the output exists regardless of the property settings.

This algorithm written by M. Bogner, August 2008
Modified by M. Bogner May 2009 to add additional delete logic and version control


 */
//AW:JAVADOC_END
public class SideInflowAlg extends decodes.tsdb.algo.AW_AlgorithmBase
{
//AW:INPUTS
	public double total_rel_above;	//AW:TYPECODE=i
	public double total_rel_below;	//AW:TYPECODE=i
	public double delta_storage;	//AW:TYPECODE=i
	public double evap;		//AW:TYPECODE=i
	String _inputNames[] = {"total_rel_above","delta_storage","total_rel_below","evap"};
//AW:INPUTS_END

//AW:LOCALVARS
// Version 1.0.03 was added by M. Bogner Aug 2012 for the 3.0 CP upgrade project
	String alg_ver = "1.0.03";
        boolean do_setoutput = true;
	double inflow_calculation = 0.0;

//AW:LOCALVARS_END

//AW:OUTPUTS
	public NamedVariable side_inflow = new NamedVariable("side_inflow", 0);
	String _outputNames[] = { "side_inflow" };
//AW:OUTPUTS_END

//AW:PROPERTIES
	public String total_rel_above_missing = "ignore";
	public String total_rel_below_missing = "ignore";
	public String delta_storage_missing = "ignore";
	public String evap_missing = "ignore";
        public String validation_flag = "";
 
	String _propertyNames[] = { "total_rel_above_missing", "delta_storage_missing",
	 "validation_flag", "evap_missing","total_rel_below_missing"};
//AW:PROPERTIES_END

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

	/**
	 * Algorithm-specific initialization provided by the subclass.
	 */
	protected void initAWAlgorithm( )
	{
//AW:INIT
		_awAlgoType = AWAlgoType.TIME_SLICE;
//AW:INIT_END

//AW:USERINIT
//AW:USERINIT_END
	}
	
	/**
	 * This method is called once before iterating all time slices.
	 */
	protected void beforeTimeSlices()
	{
//AW:BEFORE_TIMESLICES
//AW:BEFORE_TIMESLICES_END
	}

	/**
	 * 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.
	 *
	 * @throw DbCompException (or subclass thereof) if execution of this
	 *        algorithm is to be aborted.
	 */
	protected void doAWTimeSlice()
		throws DbCompException
	{
//AW:TIMESLICE
	inflow_calculation = 0.0;
	do_setoutput = true;
	if (!isMissing(total_rel_above))
		inflow_calculation = inflow_calculation - total_rel_above;
	if (!isMissing(total_rel_below))
		inflow_calculation = inflow_calculation + total_rel_below;
	if (!isMissing(delta_storage))
		inflow_calculation = inflow_calculation + delta_storage;
	if (!isMissing(evap))
		inflow_calculation = inflow_calculation + evap;

        // now test existence of inputs and their missing flags and setoutput accordingly
	if (isMissing(total_rel_above) && isMissing(total_rel_below) && isMissing(delta_storage)  && isMissing(evap)) do_setoutput = false;
	if (isMissing(total_rel_above) && total_rel_above_missing.equalsIgnoreCase("fail")) do_setoutput = false;
	if (isMissing(total_rel_below) && total_rel_below_missing.equalsIgnoreCase("fail")) do_setoutput = false;
	if (isMissing(delta_storage) && delta_storage_missing.equalsIgnoreCase("fail")) do_setoutput = false;
	if (isMissing(evap) && evap_missing.equalsIgnoreCase("fail")) do_setoutput = false;

	if (do_setoutput)
	{
		debug3("SideInflowAlg-" + alg_ver + ": total_releaseabove=" + total_rel_above +", delta_storage=" + delta_storage);
		/* added to allow users to automatically set the Validation column  */
		if (validation_flag.length() > 0) setHdbValidationFlag(side_inflow,validation_flag.charAt(1));
		setOutput(side_inflow,inflow_calculation);
	}
	else
	{
		debug3("SideInflowAlg-" + alg_ver + ": Deleting side_inflow output");
		deleteOutput(side_inflow);
	}

//AW:TIMESLICE_END
	}

	/**
	 * This method is called once after iterating all time slices.
	 */
	protected void afterTimeSlices()
	{
//AW:AFTER_TIMESLICES
//AW:AFTER_TIMESLICES_END
	}

	/**
	 * Required method returns a list of all input time series names.
	 */
	public String[] getInputNames()
	{
		return _inputNames;
	}

	/**
	 * Required method returns a list of all output time series names.
	 */
	public String[] getOutputNames()
	{
		return _outputNames;
	}

	/**
	 * Required method returns a list of properties that have meaning to
	 * this algorithm.
	 */
	public String[] getPropertyNames()
	{
		return _propertyNames;
	}
}