ReFRACtor
FullPhysics::SolarAbsorptionTable Class Reference

This class calculates the solar absorption spectrum. More...

#include <solar_absorption_table.h>

+ Inheritance diagram for FullPhysics::SolarAbsorptionTable:
+ Collaboration diagram for FullPhysics::SolarAbsorptionTable:

Public Member Functions

 SolarAbsorptionTable (const HdfFile &Hdf_static_input, const std::string &Hdf_group)
 Read the given file for the solar absorption spectrum. More...
 
virtual ~SolarAbsorptionTable ()
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 
virtual Spectrum solar_absorption_spectrum (const SpectralDomain &spec_domain) const
 This calculates the solar absorption spectrum. More...
 

Detailed Description

This class calculates the solar absorption spectrum.

This particular implementation reads a table of values, and interpolates to give a value.

Definition at line 15 of file solar_absorption_table.h.

Constructor & Destructor Documentation

◆ SolarAbsorptionTable()

SolarAbsorptionTable::SolarAbsorptionTable ( const HdfFile Hdf_static_input,
const std::string &  Hdf_group 
)

Read the given file for the solar absorption spectrum.

Definition at line 20 of file solar_absorption_table.cc.

◆ ~SolarAbsorptionTable()

virtual FullPhysics::SolarAbsorptionTable::~SolarAbsorptionTable ( )
inlinevirtual

Definition at line 19 of file solar_absorption_table.h.

Member Function Documentation

◆ print()

void SolarAbsorptionTable::print ( std::ostream &  Os) const
virtual

Reimplemented from FullPhysics::SolarAbsorptionSpectrum.

Definition at line 54 of file solar_absorption_table.cc.

◆ print_to_string()

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

◆ solar_absorption_spectrum()

Spectrum SolarAbsorptionTable::solar_absorption_spectrum ( const SpectralDomain Spec_domain) const
virtual

This calculates the solar absorption spectrum.

Parameters
Spec_domainWavenumber/Wavelength to return solar absorption spectrum for.
Returns
The solar absorption spectrum. This is unit less, it is a scaled value with 1.0 being no absorption.

Note that the spectral domain here is in the solar rest frame, not the earth rest frame used in most other places. The class SolarAbsorptionAndContinuum handles this conversion internally.

Implements FullPhysics::SolarAbsorptionSpectrum.

Definition at line 42 of file solar_absorption_table.cc.


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