// $Id:VOceanS.java 51 2006-07-12 17:13:13Z caron $
/*
* Copyright 1997-2006 Unidata Program Center/University Corporation for
* Atmospheric Research, P.O. Box 3000, Boulder, CO 80307,
* support@unidata.ucar.edu.
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or (at
* your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
* General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package ucar.nc2.dataset.transform;
import ucar.nc2.Dimension;
import ucar.nc2.Variable;
import ucar.nc2.dataset.CoordinateTransform;
import ucar.nc2.dataset.NetcdfDataset;
import ucar.nc2.dataset.TransformType;
import ucar.nc2.dataset.VerticalCT;
import ucar.unidata.geoloc.vertical.OceanSG2;
import ucar.unidata.util.Parameter;
/**
* Create a ocean_s_coordinate_g2 Vertical Transform from the information in the Coordinate Transform Variable.
*
* @author Sachin (skbhate@ngi.msstate.edu)
*/
public class VOceanSG2 extends AbstractCoordTransBuilder {
private String s = "", eta = "", depth = "", c = "", depth_c = "";
public String getTransformName() {
return "ocean_s_coordinate_g2";
}
public TransformType getTransformType() {
return TransformType.Vertical;
}
public CoordinateTransform makeCoordinateTransform(NetcdfDataset ds, Variable ctv) {
String formula_terms = getFormula(ds, ctv);
if (null == formula_terms) return null;
// :formula_terms = "s: s_rho c: Cs_r eta: zeta depth: h depth_c: hc";
String[] values = parseFormula(formula_terms, "s C eta depth depth_c");
if (values == null) return null;
s = values[0];
c = values[1];
eta = values[2];
depth = values[3];
depth_c = values[4];
CoordinateTransform rs = new VerticalCT("OceanSG2_Transform_" + ctv.getFullName(), getTransformName(), VerticalCT.Type.OceanSG2, this);
rs.addParameter(new Parameter("standard_name", getTransformName()));
rs.addParameter(new Parameter("formula_terms", formula_terms));
rs.addParameter((new Parameter("height_formula", "height(x,y,z) = eta(x,y) + (eta(x,y) + depth([n],x,y)) * ((depth_c*s(z) + depth([n],x,y)*C(z))/(depth_c+depth([n],x,y)))")));
if (!addParameter(rs, OceanSG2.ETA, ds, eta)) return null;
if (!addParameter(rs, OceanSG2.S, ds, s)) return null;
if (!addParameter(rs, OceanSG2.DEPTH, ds, depth)) return null;
if (!addParameter(rs, OceanSG2.DEPTH_C, ds, depth_c)) return null;
if (!addParameter(rs, OceanSG2.C, ds, c)) return null;
return rs;
}
public String toString() {
return "OceanSG2:" + " s:" + s + " c:" + c + " eta:" + eta + " depth:" + depth + " depth_c:" + depth_c;
}
public ucar.unidata.geoloc.vertical.VerticalTransform makeMathTransform(NetcdfDataset ds, Dimension timeDim, VerticalCT vCT) {
return new OceanSG2(ds, timeDim, vCT.getParameters());
}
}