This class implements and example Meteorological reader that reads data from an HDF file with datasets of the same name as the values. More...

#include <example_met_file.h>

Inheritance diagram for FullPhysics::ExampleMetFile:

Collaboration diagram for FullPhysics::ExampleMetFile:

Public Member Functions
	ExampleMetFile (const boost::shared_ptr< HdfFile > &input_file, const std::string &observation_id)
	Constructor. More...

	ExampleMetFile (const std::string &input_filename, const std::string &observation_id)

	~ExampleMetFile ()

blitz::Array< double, 1 >	pressure_levels () const
	Pressure levels in Pascals used for provided meteorological data. More...

void	print (std::ostream &Os) const

std::string	print_to_string () const
	Print to string. More...

blitz::Array< double, 1 >	specific_humidity () const
	Specific humidty on the meteorological pressure levels. More...

virtual blitz::Array< double, 1 >	specific_humidity (const blitz::Array< double, 1 > &Pressure_level) const
	Specific humidity interpolated to the requested pressure levels. More...

double	surface_pressure () const
	Surface pressure in Pascals. More...

blitz::Array< double, 1 >	temperature () const
	Temperature profile in Kelvins on the meteorological pressure levels. More...

virtual blitz::Array< double, 1 >	temperature (const blitz::Array< double, 1 > &Pressure_level) const
	Temperature profile in Kelvins interpolated to the requested pressure levels. More...

virtual blitz::Array< double, 1 >	vmr (const std::string &Species) const
	Volume mixing ratio for a particular species on the meteorological pressure levels. More...

virtual blitz::Array< double, 1 >	vmr (const std::string &Species, const blitz::Array< double, 1 > &Pressure_level) const
	Volume mixing ratio for a particular species interpolated to the requested pressure levels. More...

virtual double	windspeed () const
	Windspeed magnitude in m/s for the surface. More...

double	windspeed_u () const
	The U component windspeed in m/s. More...

double	windspeed_v () const
	The V component windspeed in m/s. More...

Protected Member Functions
virtual blitz::Array< double, 1 >	h2o_vmr () const
	Return the H20 VMR. More...

blitz::Array< double, 1 >	interpolate_to_grid (const blitz::Array< double, 1 > &Profile, const blitz::Array< double, 1 > &Dest_pressure_levels) const
	Interpolates a profile of data from the internal pressure grid to the supplied one. More...

Detailed Description

This class implements and example Meteorological reader that reads data from an HDF file with datasets of the same name as the values.

Definition at line 13 of file example_met_file.h.

Constructor & Destructor Documentation

◆ ExampleMetFile() [1/2]

ExampleMetFile::ExampleMetFile	(	const boost::shared_ptr< HdfFile > &	input_file,
		const std::string &	observation_id
	)

Constructor.

Parameters

input_file	HDF file with meteological data
observation_id	Identifier string that is present in the observation_ids dataset

Definition at line 20 of file example_met_file.cc.

◆ ExampleMetFile() [2/2]

ExampleMetFile::ExampleMetFile	(	const std::string &	input_filename,
		const std::string &	observation_id
	)

Definition at line 27 of file example_met_file.cc.

◆ ~ExampleMetFile()

FullPhysics::ExampleMetFile::~ExampleMetFile ( )

inline

Definition at line 17 of file example_met_file.h.

Member Function Documentation

◆ h2o_vmr()

blitz::Array< double, 1 > Meteorology::h2o_vmr ( ) const

protectedvirtualinherited

Return the H20 VMR.

This is the specific_humidity converted to a volume mixing ratio.

Definition at line 67 of file meteorology.cc.

◆ interpolate_to_grid()

Array< double, 1 > Meteorology::interpolate_to_grid	(	const blitz::Array< double, 1 > &	Profile,
		const blitz::Array< double, 1 > &	Dest_pressure_levels
	)		const

protectedinherited

Interpolates a profile of data from the internal pressure grid to the supplied one.

Uses log-log interpolation.

Definition at line 75 of file meteorology.cc.

◆ pressure_levels()

blitz::Array<double, 1> FullPhysics::ExampleMetFile::pressure_levels ( ) const

inlinevirtual

Pressure levels in Pascals used for provided meteorological data.

Implements FullPhysics::Meteorology.

Definition at line 21 of file example_met_file.h.

◆ print()

void FullPhysics::ExampleMetFile::print ( std::ostream & Os ) const

inline

Definition at line 41 of file example_met_file.h.

◆ print_to_string()

std::string FullPhysics::Printable< Meteorology >::print_to_string ( ) const

inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ specific_humidity() [1/2]

blitz::Array<double, 1> FullPhysics::ExampleMetFile::specific_humidity ( ) const

inlinevirtual

Specific humidty on the meteorological pressure levels.

Implements FullPhysics::Meteorology.

Definition at line 25 of file example_met_file.h.

◆ specific_humidity() [2/2]

virtual blitz::Array<double, 1> FullPhysics::Meteorology::specific_humidity ( const blitz::Array< double, 1 > & Pressure_level ) const

virtualinherited

Specific humidity interpolated to the requested pressure levels.

◆ surface_pressure()

double FullPhysics::ExampleMetFile::surface_pressure ( ) const

inlinevirtual

Surface pressure in Pascals.

Implements FullPhysics::Meteorology.

Definition at line 28 of file example_met_file.h.

◆ temperature() [1/2]

blitz::Array<double, 1> FullPhysics::ExampleMetFile::temperature ( ) const

inlinevirtual

Temperature profile in Kelvins on the meteorological pressure levels.

Implements FullPhysics::Meteorology.

Definition at line 38 of file example_met_file.h.

◆ temperature() [2/2]

virtual blitz::Array<double, 1> FullPhysics::Meteorology::temperature ( const blitz::Array< double, 1 > & Pressure_level ) const

virtualinherited

Temperature profile in Kelvins interpolated to the requested pressure levels.

◆ vmr() [1/2]

blitz::Array< double, 1 > Meteorology::vmr ( const std::string & Species ) const

virtualinherited

Volume mixing ratio for a particular species on the meteorological pressure levels.

Species name should use the standard molecular compound naming convention. Ie, oxygen = O2, water = H2O, etc..

Functions for computing the VMR values are registered into vmr_func_map. This base class includes an implementation for H2O VMR from specific_humidity.

Definition at line 54 of file meteorology.cc.

◆ vmr() [2/2]

virtual blitz::Array<double, 1> FullPhysics::Meteorology::vmr	(	const std::string &	Species,
		const blitz::Array< double, 1 > &	Pressure_level
	)		const

virtualinherited

Volume mixing ratio for a particular species interpolated to the requested pressure levels.

◆ windspeed()

double Meteorology::windspeed ( ) const

virtualinherited

Windspeed magnitude in m/s for the surface.

Definition at line 49 of file meteorology.cc.

◆ windspeed_u()

double FullPhysics::ExampleMetFile::windspeed_u ( ) const

inlinevirtual

The U component windspeed in m/s.

Implements FullPhysics::Meteorology.

Definition at line 31 of file example_met_file.h.

◆ windspeed_v()

double FullPhysics::ExampleMetFile::windspeed_v ( ) const

inlinevirtual

The V component windspeed in m/s.

Implements FullPhysics::Meteorology.

Definition at line 34 of file example_met_file.h.

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

Example/example_met_file.h
Example/example_met_file.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ExampleMetFile() [1/2]

◆ ExampleMetFile() [2/2]

◆ ~ExampleMetFile()

Member Function Documentation

◆ h2o_vmr()

◆ interpolate_to_grid()

◆ pressure_levels()

◆ print()

◆ print_to_string()

◆ specific_humidity() [1/2]

◆ specific_humidity() [2/2]

◆ surface_pressure()

◆ temperature() [1/2]

◆ temperature() [2/2]

◆ vmr() [1/2]

◆ vmr() [2/2]

◆ windspeed()

◆ windspeed_u()

◆ windspeed_v()