ReFRACtor
FullPhysics::DefaultConstant Class Reference

This class is an implementation of Constant that uses hard coded values suitable for Earth. More...

#include <default_constant.h>

+ Inheritance diagram for FullPhysics::DefaultConstant:
+ Collaboration diagram for FullPhysics::DefaultConstant:

Public Member Functions

 DefaultConstant ()
 
virtual ~DefaultConstant ()
 
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

This class is an implementation of Constant that uses hard coded values suitable for Earth.

This is useful for things like unit tests where we just need reasonable values.

Definition at line 10 of file default_constant.h.

Constructor & Destructor Documentation

◆ DefaultConstant()

FullPhysics::DefaultConstant::DefaultConstant ( )
inline

Definition at line 12 of file default_constant.h.

◆ ~DefaultConstant()

virtual FullPhysics::DefaultConstant::~DefaultConstant ( )
inlinevirtual

Definition at line 13 of file default_constant.h.

Member Function Documentation

◆ avogadro_constant()

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

Avogadro constant.

Implements FullPhysics::Constant.

Definition at line 71 of file default_constant.h.

◆ molar_weight_dry_air()

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

Molar weight of dry air.

Implements FullPhysics::Constant.

Definition at line 53 of file default_constant.h.

◆ molar_weight_water()

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

Molar weight of water.

Implements FullPhysics::Constant.

Definition at line 62 of file default_constant.h.

◆ print()

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

Implements FullPhysics::Constant.

Definition at line 14 of file default_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::DefaultConstant::rayleigh_a ( ) const
inlinevirtual

Rayleigh "a" value.

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

Implements FullPhysics::Constant.

Definition at line 29 of file default_constant.h.

◆ rayleigh_b()

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

Rayleigh "b" value.

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

Implements FullPhysics::Constant.

Definition at line 42 of file default_constant.h.

◆ rayleigh_depolarization_factor()

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

Rayleigh depolarization factor.

Implements FullPhysics::Constant.

Definition at line 21 of file default_constant.h.

◆ solar_distance_param()

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

The polynomial used to find the distance to the sun.

Implements FullPhysics::Constant.

Definition at line 79 of file default_constant.h.


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

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