ReFRACtor
FullPhysics::HdfConstant Class Reference

#include <hdf_constant.h>

+ Inheritance diagram for FullPhysics::HdfConstant:
+ Collaboration diagram for FullPhysics::HdfConstant:

Public Member Functions

 HdfConstant (const boost::shared_ptr< HdfFile > &Hdf_file)
 Read HDF file to get constants. More...
 
virtual ~HdfConstant ()
 
virtual DoubleWithUnit avogadro_constant () const
 Avogadro constant. More...
 
virtual DoubleWithUnit molar_weight_dry_air () const
 Molar weight of dry air. More...
 
virtual DoubleWithUnit molar_weight_water () const
 Molar weight of water. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 
virtual DoubleWithUnit rayleigh_a () const
 Rayleigh "a" value. More...
 
virtual DoubleWithUnit rayleigh_b () const
 Rayleigh "b" value. More...
 
virtual double rayleigh_depolarization_factor () const
 Rayleigh depolarization factor. More...
 
virtual boost::array< double, 7 > solar_distance_param () const
 The polynomial used to find the distance to the sun. More...
 

Detailed Description

Definition at line 10 of file hdf_constant.h.

Constructor & Destructor Documentation

◆ HdfConstant()

HdfConstant::HdfConstant ( const boost::shared_ptr< HdfFile > &  Hdf_file)

Read HDF file to get constants.

Definition at line 16 of file hdf_constant.cc.

◆ ~HdfConstant()

virtual FullPhysics::HdfConstant::~HdfConstant ( )
inlinevirtual

Definition at line 13 of file hdf_constant.h.

Member Function Documentation

◆ avogadro_constant()

virtual DoubleWithUnit FullPhysics::HdfConstant::avogadro_constant ( ) const
inlinevirtual

Avogadro constant.

Implements FullPhysics::Constant.

Definition at line 65 of file hdf_constant.h.

◆ molar_weight_dry_air()

virtual DoubleWithUnit FullPhysics::HdfConstant::molar_weight_dry_air ( ) const
inlinevirtual

Molar weight of dry air.

Implements FullPhysics::Constant.

Definition at line 49 of file hdf_constant.h.

◆ molar_weight_water()

virtual DoubleWithUnit FullPhysics::HdfConstant::molar_weight_water ( ) const
inlinevirtual

Molar weight of water.

Implements FullPhysics::Constant.

Definition at line 57 of file hdf_constant.h.

◆ print()

virtual void FullPhysics::HdfConstant::print ( std::ostream &  Os) const
inlinevirtual

Implements FullPhysics::Constant.

Definition at line 14 of file hdf_constant.h.

◆ print_to_string()

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

◆ rayleigh_a()

virtual DoubleWithUnit FullPhysics::HdfConstant::rayleigh_a ( ) const
inlinevirtual

Rayleigh "a" value.

This along with "b" are the wavelength dependence coefficients for the refractive index.

Todo:
what are the units here?

Implements FullPhysics::Constant.

Definition at line 31 of file hdf_constant.h.

◆ rayleigh_b()

virtual DoubleWithUnit FullPhysics::HdfConstant::rayleigh_b ( ) const
inlinevirtual

Rayleigh "b" value.

This along with "a" are the wavelength dependence coefficients for the refractive index.

Todo:
what are the units here?

Implements FullPhysics::Constant.

Definition at line 42 of file hdf_constant.h.

◆ rayleigh_depolarization_factor()

virtual double FullPhysics::HdfConstant::rayleigh_depolarization_factor ( ) const
inlinevirtual

Rayleigh depolarization factor.

Todo:
is this really dimensionless?

Implements FullPhysics::Constant.

Definition at line 22 of file hdf_constant.h.

◆ solar_distance_param()

virtual boost::array<double, 7> FullPhysics::HdfConstant::solar_distance_param ( ) const
inlinevirtual

The polynomial used to find the distance to the sun.

Implements FullPhysics::Constant.

Definition at line 71 of file hdf_constant.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:12