MetNoFimex::OceanSG2 Class Reference

#include <fimex/coordSys/verticalTransform/OceanSG2.h>

Inheritance diagram for MetNoFimex::OceanSG2:

Public Member Functions
	OceanSG2 (const std::string &s, const std::string &C, const std::string &depth, const std::string &depth_c, const std::string &eta="")
virtual	~OceanSG2 ()
virtual std::string	getName () const
Public Member Functions inherited from MetNoFimex::OceanSG1
	OceanSG1 (const std::string &s, const std::string &C, const std::string &depth, const std::string &depth_c, const std::string &eta="")
virtual	~OceanSG1 ()
virtual int	getPreferredVerticalType () const
	the most natural vertical type, one of the MIFI_VINT_* in fimex/mifi_constants.h More...
virtual std::string	getParameterString () const
	list the parameters More...
virtual bool	isComplete () const
Public Member Functions inherited from MetNoFimex::VerticalTransformation
virtual	~VerticalTransformation ()
virtual boost::shared_ptr< ToVLevelConverter >	getConverter (const boost::shared_ptr< CDMReader > &reader, int verticalType, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
boost::shared_ptr< ToVLevelConverter >	getConverter (const boost::shared_ptr< CDMReader > &reader, int verticalType, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs) const
	same as getConverter, but determines nx, nz, nt using MetNoFimex::getSimpleAxes from CDMUtils More...

Static Public Member Functions
static const std::string	NAME ()
Static Public Member Functions inherited from MetNoFimex::OceanSG1
static const std::string	NAME ()

Additional Inherited Members
Public Attributes inherited from MetNoFimex::OceanSG1
const std::string	s
const std::string	C
const std::string	depth
const std::string	depth_c
const std::string	eta
Protected Member Functions inherited from MetNoFimex::OceanSG1
virtual boost::shared_ptr< ToVLevelConverter >	getPressureConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nt) const
virtual boost::shared_ptr< ToVLevelConverter >	getAltitudeConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
Protected Member Functions inherited from MetNoFimex::VerticalTransformation
virtual boost::shared_ptr< ToVLevelConverter >	getHeightConverter (const boost::shared_ptr< CDMReader > &reader, size_t unLimDimPos, boost::shared_ptr< const CoordinateSystem > cs, size_t nx, size_t ny, size_t nz, size_t nt) const
Protected Attributes inherited from MetNoFimex::OceanSG1
int(*	heightConversionFunction )(size_t n, double h, double h_c, double zeta, const double *sigma, const double *C, double *z)

Detailed Description

ocean_s_coordinate_g2 is defined by the same set of parameters, just the conversion function is different.

Constructor & Destructor Documentation

MetNoFimex::OceanSG2::OceanSG2	(	const std::string &	s,
		const std::string &	C,
		const std::string &	depth,
		const std::string &	depth_c,
		const std::string &	eta = ""
	)

Initialize OceanSG2 with formula as defined by https://www.myroms.org/wiki/index.php/Vertical_S-coordinate

Parameters

s	fractional vertical stretching coordinate sigma(k)
C	free surface C(x,y,t)
depth	unperturbed ocean-depth depth(x,y)
depth_c	critical depth, usually min(depth(x,y))
eta	optional time-varying free surface eta(x,y,z) (often also called zeta)

virtual MetNoFimex::OceanSG2::~OceanSG2 ( )

inlinevirtual

Member Function Documentation

virtual std::string MetNoFimex::OceanSG2::getName ( ) const

inlinevirtual

Returns

same as static NAME()

Reimplemented from MetNoFimex::OceanSG1.

References NAME().

static const std::string MetNoFimex::OceanSG2::NAME ( )

inlinestatic

static NAME constant

Returns

ocean_s_coordinate_g2

Referenced by getName().

---

The documentation for this class was generated from the following file:

• include/fimex/coordSys/verticalTransform/OceanSG2.h