Convert a CF parameterless vertical coordinate to an Ocean s-coordinate, generic form 1 or 2. More...

#include <DerivedVar.h>

Inheritance diagram for VAPoR::DerivedCoordVarStandardOceanSCoordinate:

Public Member Functions
	DerivedCoordVarStandardOceanSCoordinate (DC *dc, string mesh, string formula)

virtual	~DerivedCoordVarStandardOceanSCoordinate ()

virtual int	Initialize ()

virtual bool	GetBaseVarInfo (DC::BaseVar &var) const

virtual bool	GetCoordVarInfo (DC::CoordVar &cvar) const

virtual std::vector< string >	GetInputs () const

virtual int	GetDimLensAtLevel (int level, std::vector< size_t > &dims_at_level, std::vector< size_t > &bs_at_level) const

virtual size_t	GetNumRefLevels () const

virtual std::vector< size_t >	GetCRatios () const

virtual int	OpenVariableRead (size_t ts, int level=0, int lod=0)

virtual int	CloseVariable (int fd)

virtual int	ReadRegion (int fd, const std::vector< size_t > &min, const std::vector< size_t > &max, float *region)

virtual bool	VariableExists (size_t ts, int reflevel, int lod) const

Public Member Functions inherited from VAPoR::DerivedCFVertCoordVar
	DerivedCFVertCoordVar (string varName, DC *dc, string mesh, string formula)

virtual	~DerivedCFVertCoordVar ()

virtual bool	GetCoordVarInfo (DC::CoordVar &cvar) const =0

Public Member Functions inherited from VAPoR::DerivedCoordVar
	DerivedCoordVar (string varName)

virtual	~DerivedCoordVar ()

virtual bool	GetCoordVarInfo (DC::CoordVar &cvar) const =0

Public Member Functions inherited from VAPoR::DerivedVar
	DerivedVar (string varName)

virtual	~DerivedVar ()

virtual int	Initialize ()=0

string	GetName () const

virtual bool	GetBaseVarInfo (DC::BaseVar &var) const =0

virtual bool	GetAtt (string attname, std::vector< double > &values) const

virtual bool	GetAtt (string attname, std::vector< long > &values) const

virtual bool	GetAtt (string attname, string &values) const

virtual std::vector< string >	GetAttNames () const

virtual DC::XType	GetAttType (string attname) const

virtual std::vector< string >	GetInputs () const =0

virtual int	GetDimLensAtLevel (int level, std::vector< size_t > &dims_at_level, std::vector< size_t > &bs_at_level) const =0

virtual int	GetDimLensAtLevel (int level, std::vector< size_t > &dims_at_level, std::vector< size_t > &bs_at_level, long ts) const

virtual size_t	GetNumRefLevels () const

virtual std::vector< size_t >	GetCRatios () const

virtual int	OpenVariableRead (size_t ts, int level=0, int lod=0)=0

virtual int	CloseVariable (int fd)=0

virtual int	ReadRegion (int fd, const std::vector< size_t > &min, const std::vector< size_t > &max, float *region)=0

virtual int	ReadRegion (int fd, const std::vector< size_t > &min, const std::vector< size_t > &max, double *region)

virtual bool	VariableExists (size_t ts, int reflevel, int lod) const =0

Public Member Functions inherited from Wasp::MyBase
	MyBase ()

const string &	getClassName () const

Static Public Member Functions
static bool	ValidFormula (string formula)

Static Public Member Functions inherited from VAPoR::DerivedCFVertCoordVar
static bool	ParseFormula (string formula_terms, map< string, string > &parsed_terms)

static bool	ValidFormula (const vector< string > &required_terms, string formula)

Static Public Member Functions inherited from Wasp::MyBase
static void	SetErrMsg (const char *format,...)
	Record a formatted error message.

static void	SetErrMsg (int errcode, const char *format,...)
	Record a formatted error message and an error code.

static const char *	GetErrMsg ()

static void	SetErrCode (int err_code)
	Record an error code.

static int	GetErrCode ()
	Retrieve the current error code.

static void	SetErrMsgCB (ErrMsgCB_T cb)

static ErrMsgCB_T	GetErrMsgCB ()

static void	SetErrMsgFilePtr (FILE *fp)

static const FILE *	SetErrMsgFilePtr ()

static void	SetDiagMsg (const char *format,...)
	Record a formatted diagnostic message.

static const char *	GetDiagMsg ()

static void	SetDiagMsgCB (DiagMsgCB_T cb)

static DiagMsgCB_T	GetDiagMsgCB ()

static void	SetDiagMsgFilePtr (FILE *fp)

static bool	EnableErrMsg (bool enable)

static bool	GetEnableErrMsg ()

Additional Inherited Members
Public Types inherited from Wasp::MyBase
typedef void(*	ErrMsgCB_T) (const char *msg, int err_code)

typedef void(*	DiagMsgCB_T) (const char *msg)

Static Public Attributes inherited from Wasp::MyBase
static char *	ErrMsg

static int	ErrCode

static int	ErrMsgSize

static FILE *	ErrMsgFilePtr

static ErrMsgCB_T	ErrMsgCB

static char *	DiagMsg

static int	DiagMsgSize

static FILE *	DiagMsgFilePtr

static DiagMsgCB_T	DiagMsgCB

static bool	Enabled

Protected Member Functions inherited from VAPoR::DerivedVar
int	_getVar (DC dc, size_t ts, string varname, int level, int lod, const std::vector< size_t > &min, const std::vector< size_t > &max, float region) const

int	_getVarDestagger (DC dc, size_t ts, string varname, int level, int lod, const std::vector< size_t > &min, const std::vector< size_t > &max, float region, int stagDim) const

Protected Member Functions inherited from Wasp::MyBase
void	SetClassName (const string &name)

Protected Attributes inherited from VAPoR::DerivedCFVertCoordVar
DC *	_dc

string	_mesh

string	_formula

Protected Attributes inherited from VAPoR::DerivedVar
string	_derivedVarName

DC::FileTable	_fileTable

Detailed Description

Convert a CF parameterless vertical coordinate to an Ocean s-coordinate, generic form 1 or 2.

This derived class converts a dimensionless sigma coordinate variable to either a Ocean s-coordinate, generic form 1 or 2

See also: http://cfconventions.org/

Definition at line 617 of file DerivedVar.h.

Constructor & Destructor Documentation

◆ DerivedCoordVarStandardOceanSCoordinate()

VAPoR::DerivedCoordVarStandardOceanSCoordinate::DerivedCoordVarStandardOceanSCoordinate	(	DC *	dc,
		string	mesh,
		string	formula
	)

◆ ~DerivedCoordVarStandardOceanSCoordinate()

virtual VAPoR::DerivedCoordVarStandardOceanSCoordinate::~DerivedCoordVarStandardOceanSCoordinate ( )

inlinevirtual

Definition at line 620 of file DerivedVar.h.

Member Function Documentation

◆ CloseVariable()

virtual int VAPoR::DerivedCoordVarStandardOceanSCoordinate::CloseVariable ( int fd )

virtual

Implements VAPoR::DerivedVar.

◆ GetBaseVarInfo()

virtual bool VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetBaseVarInfo ( DC::BaseVar & var ) const

virtual

Implements VAPoR::DerivedVar.

◆ GetCoordVarInfo()

virtual bool VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetCoordVarInfo ( DC::CoordVar & cvar ) const

virtual

Implements VAPoR::DerivedCFVertCoordVar.

◆ GetCRatios()

virtual std::vector< size_t > VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetCRatios ( ) const

inlinevirtual

Reimplemented from VAPoR::DerivedVar.

Definition at line 634 of file DerivedVar.h.

◆ GetDimLensAtLevel()

virtual int VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetDimLensAtLevel	(	int	level,
		std::vector< size_t > &	dims_at_level,
		std::vector< size_t > &	bs_at_level
	)		const

virtual

Implements VAPoR::DerivedVar.

◆ GetInputs()

virtual std::vector< string > VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetInputs ( ) const

virtual

Implements VAPoR::DerivedVar.

◆ GetNumRefLevels()

virtual size_t VAPoR::DerivedCoordVarStandardOceanSCoordinate::GetNumRefLevels ( ) const

inlinevirtual

Reimplemented from VAPoR::DerivedVar.

Definition at line 632 of file DerivedVar.h.

◆ Initialize()

virtual int VAPoR::DerivedCoordVarStandardOceanSCoordinate::Initialize ( )

virtual

Implements VAPoR::DerivedVar.

◆ OpenVariableRead()

virtual int VAPoR::DerivedCoordVarStandardOceanSCoordinate::OpenVariableRead	(	size_t	ts,
		int	level = `0`,
		int	lod = `0`
	)

virtual

Implements VAPoR::DerivedVar.

◆ ReadRegion()

virtual int VAPoR::DerivedCoordVarStandardOceanSCoordinate::ReadRegion	(	int	fd,
		const std::vector< size_t > &	min,
		const std::vector< size_t > &	max,
		float *	region
	)

virtual

Implements VAPoR::DerivedVar.

◆ ValidFormula()

static bool VAPoR::DerivedCoordVarStandardOceanSCoordinate::ValidFormula ( string formula )

static

◆ VariableExists()

virtual bool VAPoR::DerivedCoordVarStandardOceanSCoordinate::VariableExists	(	size_t	ts,
		int	reflevel,
		int	lod
	)		const

virtual

Implements VAPoR::DerivedVar.

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

/Users/pearse/VAPOR/include/vapor/DerivedVar.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DerivedCoordVarStandardOceanSCoordinate()

◆ ~DerivedCoordVarStandardOceanSCoordinate()

Member Function Documentation

◆ CloseVariable()

◆ GetBaseVarInfo()

◆ GetCoordVarInfo()

◆ GetCRatios()

◆ GetDimLensAtLevel()

◆ GetInputs()

◆ GetNumRefLevels()

◆ Initialize()

◆ OpenVariableRead()

◆ ReadRegion()

◆ ValidFormula()

◆ VariableExists()