FullPhysics::Constant Class Reference

This class contains various constants. More...

#include <constant.h>

Inheritance diagram for FullPhysics::Constant:

Collaboration diagram for FullPhysics::Constant:

Public Member Functions
virtual	~Constant ()
virtual DoubleWithUnit	avogadro_constant () const =0
	Avogadro constant. More...
virtual DoubleWithUnit	molar_weight_dry_air () const =0
	Molar weight of dry air. More...
virtual DoubleWithUnit	molar_weight_water () const =0
	Molar weight of water. More...
virtual void	print (std::ostream &Os) const =0
std::string	print_to_string () const
	Print to string. More...
virtual DoubleWithUnit	rayleigh_a () const =0
	Rayleigh "a" value. More...
virtual DoubleWithUnit	rayleigh_b () const =0
	Rayleigh "b" value. More...
virtual double	rayleigh_depolarization_factor () const =0
	Rayleigh depolarization factor. More...
virtual boost::array< double, 7 >	solar_distance_param () const =0
	The polynomial used to find the distance to the sun. More...

Detailed Description

This class contains various constants.

We have this in a separate class rather than just having a header of constants so that we can replace these constants. In particular, some of the constants depend on the planet we are working on (e.g., Venus).

Definition at line 11 of file constant.h.

Constructor & Destructor Documentation

~Constant()

virtual FullPhysics::Constant::~Constant ( )

inlinevirtual

Definition at line 13 of file constant.h.

Member Function Documentation

avogadro_constant()

virtual DoubleWithUnit FullPhysics::Constant::avogadro_constant ( ) const

pure virtual

Avogadro constant.

Implemented in FullPhysics::DefaultConstant, and FullPhysics::HdfConstant.

molar_weight_dry_air()

virtual DoubleWithUnit FullPhysics::Constant::molar_weight_dry_air ( ) const

pure virtual

Molar weight of dry air.

Implemented in FullPhysics::DefaultConstant, and FullPhysics::HdfConstant.

molar_weight_water()

virtual DoubleWithUnit FullPhysics::Constant::molar_weight_water ( ) const

pure virtual

Molar weight of water.

Implemented in FullPhysics::DefaultConstant, and FullPhysics::HdfConstant.

print()

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

pure virtual

Implemented in FullPhysics::HdfConstant, and FullPhysics::DefaultConstant.

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::Constant::rayleigh_a ( ) const

pure virtual

Rayleigh "a" value.

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

Implemented in FullPhysics::HdfConstant, and FullPhysics::DefaultConstant.

rayleigh_b()

virtual DoubleWithUnit FullPhysics::Constant::rayleigh_b ( ) const

pure virtual

Rayleigh "b" value.

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

Implemented in FullPhysics::HdfConstant, and FullPhysics::DefaultConstant.

rayleigh_depolarization_factor()

virtual double FullPhysics::Constant::rayleigh_depolarization_factor ( ) const

pure virtual

Rayleigh depolarization factor.

Implemented in FullPhysics::HdfConstant, and FullPhysics::DefaultConstant.

solar_distance_param()

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

pure virtual

The polynomial used to find the distance to the sun.

Implemented in FullPhysics::DefaultConstant, and FullPhysics::HdfConstant.

---

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

• Support/constant.h