ReFRACtor
FullPhysics::SolarContinuumPolynomial Class Reference

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

#include <solar_continuum_polynomial.h>

+ Inheritance diagram for FullPhysics::SolarContinuumPolynomial:
+ Collaboration diagram for FullPhysics::SolarContinuumPolynomial:

Public Member Functions

 SolarContinuumPolynomial (const ArrayWithUnit< double, 1 > &Param, bool Convert_from_photon=true)
 Constructor. More...
 
virtual ~SolarContinuumPolynomial ()
 
virtual void print (std::ostream &Os) const
 Print description of object. More...
 
std::string print_to_string () const
 Print to string. More...
 
virtual Spectrum solar_continuum_spectrum (const SpectralDomain &spec_domain) const
 This calculate the solar continuum spectrum. More...
 

Detailed Description

This class calculates the solar continuum spectrum.

This particular implementation uses a polynomial parametrization to calculate the Solar Planck Function.

Definition at line 15 of file solar_continuum_polynomial.h.

Constructor & Destructor Documentation

◆ SolarContinuumPolynomial()

SolarContinuumPolynomial::SolarContinuumPolynomial ( const ArrayWithUnit< double, 1 > &  Param,
bool  Convert_from_photon = true 
)

Constructor.

There are two conventions used for the reported solar spectrum. For OCO, we give the results as ph/s/m^2/micron, while for GOSAT we convert using the number of photons at each wavenumber to give W/m^2/cm^-1. You can choose the convention used by specifying if we Convert_from_photon or not.

Definition at line 25 of file solar_continuum_polynomial.cc.

◆ ~SolarContinuumPolynomial()

virtual FullPhysics::SolarContinuumPolynomial::~SolarContinuumPolynomial ( )
inlinevirtual

Definition at line 19 of file solar_continuum_polynomial.h.

Member Function Documentation

◆ print()

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

Print description of object.

Reimplemented from FullPhysics::SolarContinuumSpectrum.

Definition at line 39 of file solar_continuum_polynomial.cc.

◆ print_to_string()

std::string FullPhysics::Printable< SolarContinuumSpectrum >::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_continuum_spectrum()

Spectrum SolarContinuumPolynomial::solar_continuum_spectrum ( const SpectralDomain Spec_domain) const
virtual

This calculate the solar continuum spectrum.

This calculates this at an Earth-Sun distance of 1 AU, this needs to be scaled by the square of the actual distance.

Parameters
Spec_domainWavenumber/Wavelength to return solar continuum spectrum for.
Returns
The solar continuum spectrum at 1 AU.

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::SolarContinuumSpectrum.

Definition at line 52 of file solar_continuum_polynomial.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