ReFRACtor
FullPhysics::PressureLevelInput Class Reference

In a retrieval, there are typically two different pressure levels of interest. More...

#include <pressure_level_input.h>

+ Inheritance diagram for FullPhysics::PressureLevelInput:
+ Collaboration diagram for FullPhysics::PressureLevelInput:

Public Member Functions

 PressureLevelInput (const blitz::Array< double, 1 > &Press_level)
 Constructor. More...
 
 PressureLevelInput (const HdfFile &Hdf_file, const std::string &Hdf_group="Pressure")
 Constructor. More...
 
virtual ~PressureLevelInput ()
 
const blitz::Array< double, 1 > & pressure_level () const
 Pressure levels that input data was defined on. More...
 
void print (std::ostream &Os) const
 Print to a stream. More...
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

In a retrieval, there are typically two different pressure levels of interest.

One is the pressure levels where various initial parameters are defined, e.g. Temperature read from an ECMWF file at specific pressure levels. The second set is the current pressure levels that define the layers used in the Radiative Transfer calculation. The first set is fixed constant level, it is whatever was used when we initial read the input data. The second will potentially vary as we do a retrieval.

This class captures the first, fixed set of pressure levels. This is little more than an Array of values.

Definition at line 22 of file pressure_level_input.h.

Constructor & Destructor Documentation

◆ PressureLevelInput() [1/2]

FullPhysics::PressureLevelInput::PressureLevelInput ( const blitz::Array< double, 1 > &  Press_level)
inline

Constructor.

Parameters
Press_levelThe pressure levels in ascending order. This is in Pascals.

Definition at line 30 of file pressure_level_input.h.

◆ PressureLevelInput() [2/2]

FullPhysics::PressureLevelInput::PressureLevelInput ( const HdfFile Hdf_file,
const std::string &  Hdf_group = "Pressure" 
)
inline

Constructor.

Parameters
Hdf_fileThe HdfFile to read. This reads the given HDF group.
Hdf_groupThe HDF group to read.

Definition at line 40 of file pressure_level_input.h.

◆ ~PressureLevelInput()

virtual FullPhysics::PressureLevelInput::~PressureLevelInput ( )
inlinevirtual

Definition at line 44 of file pressure_level_input.h.

Member Function Documentation

◆ pressure_level()

const blitz::Array<double, 1>& FullPhysics::PressureLevelInput::pressure_level ( ) const
inline

Pressure levels that input data was defined on.

Returns
Pressure level in ascending order, in Pascals.

Definition at line 51 of file pressure_level_input.h.

◆ print()

void PressureLevelInput::print ( std::ostream &  Os) const

Print to a stream.

Definition at line 16 of file pressure_level_input.cc.

◆ print_to_string()

std::string FullPhysics::Printable< PressureLevelInput >::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.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13