MetNoFimex::AtmosphereSigma Class Reference

Sigma pressure vertical coordinate. More...

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

Inheritance diagram for MetNoFimex::AtmosphereSigma:

Public Member Functions
	AtmosphereSigma (const std::string &sigma, const std::string &ptop, const std::string &ps)
virtual	~AtmosphereSigma ()
virtual std::string	getName () const
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 ()

Public Attributes
const std::string	sigma
const std::string	ps
const std::string	ptop

Protected Member Functions
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
Protected Member Functions inherited from MetNoFimex::VerticalTransformation
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
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

Detailed Description

Sigma pressure vertical coordinate.

Constructor & Destructor Documentation

MetNoFimex::AtmosphereSigma::AtmosphereSigma ( const std::string &  sigma, const std::string &  ptop, const std::string &  ps  )

inline

Initialize AtmosphereSigma with formula p(k, x,y,t) = ptop + sigma(k)*(ps(x,y,t)-ptop)

Parameters

sigma	dimensionless parameter
ptop	top of model
ps	surface pressure

virtual MetNoFimex::AtmosphereSigma::~AtmosphereSigma ( )

inlinevirtual

Member Function Documentation

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

inlinevirtual

Returns

same as static NAME()

Implements MetNoFimex::VerticalTransformation.

References NAME().

virtual std::string MetNoFimex::AtmosphereSigma::getParameterString ( ) const

inlinevirtual

list the parameters

Implements MetNoFimex::VerticalTransformation.

References ptop.

virtual int MetNoFimex::AtmosphereSigma::getPreferredVerticalType ( ) const

inlinevirtual

the most natural vertical type, one of the MIFI_VINT_* in fimex/mifi_constants.h

Implements MetNoFimex::VerticalTransformation.

References MIFI_VINT_PRESSURE.

virtual boost::shared_ptr<ToVLevelConverter> MetNoFimex::AtmosphereSigma::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

protectedvirtual

Implements MetNoFimex::VerticalTransformation.

Referenced by isComplete().

virtual bool MetNoFimex::AtmosphereSigma::isComplete ( ) const

inlinevirtual

Indicate if all parameters are given to fully describe the transformation.

Even a fully described transformation does not guarantee that a converter exists (e.g. height -> altitude requires in addition topography).

And converters might exist, even if a transformation is not complete.

Implements MetNoFimex::VerticalTransformation.

References getPressureConverter().

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

inlinestatic

static NAME constant

Returns

atmosphere_sigma_coordinate

Referenced by getName().

Member Data Documentation

const std::string MetNoFimex::AtmosphereSigma::ps

const std::string MetNoFimex::AtmosphereSigma::ptop

Referenced by getParameterString().

const std::string MetNoFimex::AtmosphereSigma::sigma

---

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

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