 |
ReFRACtor
|
|
ReFRACtor
|
This class maintains the absorber portion of the state. More...
#include <absorber.h>
Inheritance diagram for FullPhysics::Absorber: Collaboration diagram for FullPhysics::Absorber:Public Member Functions | |
| virtual | ~Absorber () |
| virtual boost::shared_ptr< AbsorberVmr > | absorber_vmr (const std::string &gas_name) const =0 |
| Returns the AbsorberVmr object for a given species index. More... | |
| virtual void | add_observer (Observer< Absorber > &Obs) |
| Add an observer. More... | |
| void | add_observer_and_keep_reference (boost::shared_ptr< Observer< Absorber > > &Obs) |
| Add an observer and keep a reference to it. More... | |
| virtual boost::shared_ptr< Absorber > | clone () const =0 |
| Clone an Absorber object. More... | |
| virtual boost::shared_ptr< Absorber > | clone (const boost::shared_ptr< Pressure > &Press, const boost::shared_ptr< Temperature > &Temp, const std::vector< boost::shared_ptr< Altitude > > &Alt) const =0 |
| This version of clone takes a Pressure, Altitude and Temperature to use. More... | |
| virtual int | gas_index (const std::string &Name) const |
| Map a gas name to the index number it appears in optical_depth_each_layer. More... | |
| virtual std::string | gas_name (int Species_index) const =0 |
| Name of gases, in the order that optical_depth_each_layer returns them. More... | |
| virtual void | mark_used (const StateVector &Sv, blitz::Array< bool, 1 > &Used) const |
| Mark elements that we are actively using (i.e., that aren't ignored). More... | |
| virtual void | notify_add (StateVector &Observed_object) |
| Called when an object is added to an Observable. More... | |
| virtual void | notify_add () |
| virtual void | notify_remove (StateVector &Observed_object) |
| Called when an object is removed from an Observable. More... | |
| virtual void | notify_remove () |
| virtual void | notify_update (const StateVector &Observed_object) |
| Called when the Observed object is updated. More... | |
| virtual int | number_species () const |
| Number of species. More... | |
| virtual ArrayAd< double, 2 > | optical_depth_each_layer (double wn, int spec_index) const =0 |
| This gives the optical depth for each layer, for the given wave number. More... | |
| virtual void | print (std::ostream &Os) const |
| std::string | print_to_string () const |
| Print to string. More... | |
| virtual void | remove_observer (Observer< Absorber > &Obs) |
| Remove an observer. More... | |
| virtual void | state_vector_name (const StateVector &Sv, blitz::Array< std::string, 1 > &Sv_name) const |
| Update any portion of the list of the state vector names that apply to this object. More... | |
| virtual AutoDerivative< double > | xgas (const std::string &Gas_name) const =0 |
| This calculates the gas column, e.g., XCO2. More... | |
Static Public Attributes | |
| static AccumulatedTimer | timer |
| Timer for optical_depth_each_layer. More... | |
Protected Member Functions | |
| void | add_observer_do (Observer< Absorber > &Obs, Absorber &t) |
| Add an observer. More... | |
| void | add_observer_do (Observer< Absorber > &Obs) |
| void | clean_dead_ptr () |
| Remove any dead pointers. More... | |
| void | notify_update_do (const Absorber &Self) |
| Function to call to notify Observers of a state change. More... | |
| void | remove_observer_do (Observer< Absorber > &Obs, Absorber &t) |
| Remove an observer. More... | |
| void | remove_observer_do (Observer< Absorber > &Obs) |
Protected Attributes | |
| std::list< boost::weak_ptr< Observer< Absorber > > > | olist |
| std::vector< boost::shared_ptr< Observer< Absorber > > > | ref_list |
This class maintains the absorber portion of the state.
Other objects may depend on the absorber, and should be updated when the absorber is updated. To facilitate that, this class in an Oberverable, and objects can add themselves as Observers to be notified when the absorber is updated.
Because the absorber calculation tends to be a bottle neck, we keep a timer in this class. This class keeps track of the time used in the optical_depth_each_layer function. Other classes can make use of this information for logging if desired.
Definition at line 27 of file absorber.h.
|
inlinevirtual |
Definition at line 30 of file absorber.h.
|
pure virtual |
Returns the AbsorberVmr object for a given species index.
Implemented in FullPhysics::AbsorberAbsco.
Add an observer.
Implements FullPhysics::Observable< Absorber >.
Definition at line 32 of file absorber.h.
|
inlineinherited |
Add an observer and keep a reference to it.
See the discussion in the Observer class description for details.
Definition at line 107 of file observer.h.
|
inlineprotectedinherited |
Add an observer.
Definition at line 148 of file observer.h.
|
inlineprotectedinherited |
Definition at line 159 of file observer.h.
|
inlineprotectedinherited |
Remove any dead pointers.
Definition at line 196 of file observer.h.
|
pure virtual |
Clone an Absorber object.
Note that the cloned version will not be attached to and StateVector or Observer<Absorber>, although you can of course attach them after receiving the cloned object.
Because this isn't attached to the StateVector, one use of the clone operator is to create a "frozen" Absorber object.
Implemented in FullPhysics::AbsorberAbsco.
|
pure virtual |
This version of clone takes a Pressure, Altitude and Temperature to use.
The intent is that the Pressure, Altitude and Temperature has been cloned from the original Pressure, Altitude and Temperature (although this class has no way to verify this). This allows sets of objects to be cloned using a common Pressure, Altitude and Temperature clones, e.g. Atmosphere.
Implemented in FullPhysics::AbsorberAbsco.
|
virtual |
Map a gas name to the index number it appears in optical_depth_each_layer.
This return -1 if the Name is not one of the gases.
Definition at line 28 of file absorber.cc.
|
pure virtual |
Name of gases, in the order that optical_depth_each_layer returns them.
Implemented in FullPhysics::AbsorberAbsco.
|
inlinevirtualinherited |
Mark elements that we are actively using (i.e., that aren't ignored).
You only need to mark the ones that are used as true, everything is already initialized as false. Default is to do nothing.
Reimplemented in FullPhysics::SubStateVectorObserver.
Definition at line 26 of file state_vector_observer.h.
|
inlinevirtualinherited |
Called when an object is added to an Observable.
Default is to do nothing.
Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.
Definition at line 47 of file observer.h.
|
inlinevirtualinherited |
Definition at line 48 of file observer.h.
|
inlinevirtualinherited |
Called when an object is removed from an Observable.
Default is to do nothing.
Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.
Definition at line 55 of file observer.h.
|
inlinevirtualinherited |
Definition at line 56 of file observer.h.
|
inlinevirtualinherited |
Called when the Observed object is updated.
Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::RadianceScalingSvFit, FullPhysics::AbsorberAbsco, FullPhysics::AerosolOptical, and FullPhysics::SubStateVectorObserver.
Definition at line 40 of file observer.h.
|
inlineprotectedinherited |
Function to call to notify Observers of a state change.
The object should pass itself to this function, so it can be passed to the Observers.
Definition at line 121 of file observer.h.
|
inlinevirtual |
Number of species.
Reimplemented in FullPhysics::AbsorberAbsco.
Definition at line 41 of file absorber.h.
|
pure virtual |
This gives the optical depth for each layer, for the given wave number.
Note this only includes the Absorbers portion of this, Atmosphere class combines this with Rayleigh and Aerosol scattering.
This has size of pres->number_active_layer() x number_species()
We include the derivative of this with respect to the state vector.
Implemented in FullPhysics::AbsorberAbsco.
|
inlinevirtualinherited |
Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::AbsorberAbsco, FullPhysics::SolarAbsorptionAndContinuum, FullPhysics::PressureFixedLevel, FullPhysics::Instrument, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::AerosolOptical, FullPhysics::SubStateVectorObserver, FullPhysics::RadianceScaling, FullPhysics::IlsInstrument, FullPhysics::AerosolPropertyRhHdf, FullPhysics::IlsConvolution, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolPropertyImpBase, FullPhysics::AerosolExtinctionLog, FullPhysics::PressureSigma, FullPhysics::RadianceScalingLinearFit, FullPhysics::AerosolExtinctionLinear, FullPhysics::AerosolExtinctionImpBase, FullPhysics::PressureImpBase, FullPhysics::StokesCoefficientImpBase, FullPhysics::GroundLambertian, FullPhysics::TemperatureImpBase, FullPhysics::AerosolPropertyHdf, FullPhysics::FluorescenceEffect, FullPhysics::AbsorberVmrImpBase, FullPhysics::SolarModel, FullPhysics::InstrumentDoppler, FullPhysics::GroundCoxmunk, FullPhysics::ApplyInstrumentUnits, FullPhysics::GroundCoxmunkPlusLambertian, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrMet, FullPhysics::SubStateVectorProxy, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrLevelScaled, FullPhysics::TemperatureFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::StokesCoefficientFraction, FullPhysics::TemperatureMet, FullPhysics::TemperatureLevelOffset, FullPhysics::TemperatureOffset, and FullPhysics::StokesCoefficientConstant.
Definition at line 37 of file state_vector_observer.h.
|
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.
Remove an observer.
Implements FullPhysics::Observable< Absorber >.
Definition at line 34 of file absorber.h.
|
inlineprotectedinherited |
Remove an observer.
Definition at line 173 of file observer.h.
|
inlineprotectedinherited |
Definition at line 181 of file observer.h.
|
inlinevirtualinherited |
Update any portion of the list of the state vector names that apply to this object.
Default is to do nothing.
Reimplemented in FullPhysics::SubStateVectorObserver.
Definition at line 34 of file state_vector_observer.h.
|
pure virtual |
This calculates the gas column, e.g., XCO2.
This is the dry air mole fraction of the gas, see section 3.5.4 of the ATB
We include the derivative of this with respect to the state vector.
Implemented in FullPhysics::AbsorberAbsco.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
|
static |
Timer for optical_depth_each_layer.
Definition at line 31 of file absorber.h.
