 |
ReFRACtor
|
|
ReFRACtor
|
This class maintains the pressure portion of the state. More...
#include <pressure.h>
Inheritance diagram for FullPhysics::Pressure: Collaboration diagram for FullPhysics::Pressure:Public Member Functions | |
| virtual | ~Pressure () |
| virtual void | add_observer (Observer< Pressure > &Obs) |
| Add an observer. More... | |
| void | add_observer_and_keep_reference (boost::shared_ptr< Observer< Pressure > > &Obs) |
| Add an observer and keep a reference to it. More... | |
| virtual boost::shared_ptr< Pressure > | clone () const =0 |
| Clone a Pressure object. 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 int | max_number_level () const |
| The maximum number of levels that we can have. 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... | |
| int | number_layer () const |
| This is the number of layers. More... | |
| int | number_level () const |
| This is the number of levels. More... | |
| virtual ArrayAdWithUnit< double, 1 > | pressure_grid () const =0 |
| This returns the pressure grid to use for layer retrieval, along with the gradient of each of the pressure grid values with the state vector. More... | |
| virtual void | print (std::ostream &Os) const |
| std::string | print_to_string () const |
| Print to string. More... | |
| virtual void | remove_observer (Observer< Pressure > &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... | |
| AutoDerivativeWithUnit< double > | surface_pressure () const |
| Return surface pressure, which is just the pressure at the bottom level of pressure_grid. More... | |
| double | surface_pressure_value () const |
| Return the current surface pressure value, without the gradient. More... | |
Protected Member Functions | |
| void | add_observer_do (Observer< Pressure > &Obs, Pressure &t) |
| Add an observer. More... | |
| void | add_observer_do (Observer< Pressure > &Obs) |
| void | clean_dead_ptr () |
| Remove any dead pointers. More... | |
| void | notify_update_do (const Pressure &Self) |
| Function to call to notify Observers of a state change. More... | |
| void | remove_observer_do (Observer< Pressure > &Obs, Pressure &t) |
| Remove an observer. More... | |
| void | remove_observer_do (Observer< Pressure > &Obs) |
Protected Attributes | |
| std::list< boost::weak_ptr< Observer< Pressure > > > | olist |
| std::vector< boost::shared_ptr< Observer< Pressure > > > | ref_list |
This class maintains the pressure portion of the state.
Note that in a retrieval, there are typically two different pressure levels of interest. On is the pressure levels where various initial parameters are defined, e.g. Temperature read from an ECMWF file at specific pressure levels. The second set is the current pressure levels that define the layers used in the Radiative Transfer calculation. The first set is fixed constant level, it is whatever was used when we initial read the input data. The second will potentially vary as we do a retrieval.
This class captures the second, potentially varying set of pressure.
Other classes typically depend on the pressure levels, e.g., Altitude. As a convenience to these classes, the Pressure class can notify them when it is changed. These classes can register themselves as Observers of the Pressure object if desired.
When implementing a new class, you almost always will want to derive from PressureImpBase rather than from this class. See that class for a description.
Definition at line 32 of file pressure.h.
|
inlinevirtual |
Definition at line 35 of file pressure.h.
Add an observer.
Implements FullPhysics::Observable< Pressure >.
Definition at line 36 of file pressure.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 a Pressure object.
Note that the cloned version will not be attached to a StateVector or Observer<Pressure>, 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" Pressure object.
Implemented in FullPhysics::PressureFixedLevel, FullPhysics::PressureSigma, and FullPhysics::PressureImpBase.
|
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.
|
inlinevirtual |
The maximum number of levels that we can have.
The default is just number_level() (i.e., we don't change the number of levels from one iteration to the next).
Reimplemented in FullPhysics::PressureFixedLevel.
Definition at line 79 of file pressure.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.
|
inline |
This is the number of layers.
This is the same as pressure_grid.rows() - 1.
Definition at line 64 of file pressure.h.
|
inline |
This is the number of levels.
This is the same as pressure_grid.rows() - 1.
Definition at line 71 of file pressure.h.
|
pure virtual |
This returns the pressure grid to use for layer retrieval, along with the gradient of each of the pressure grid values with the state vector.
Implemented in FullPhysics::PressureImpBase.
|
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< Pressure >.
Definition at line 38 of file pressure.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.
| AutoDerivativeWithUnit< double > Pressure::surface_pressure | ( | ) | const |
Return surface pressure, which is just the pressure at the bottom level of pressure_grid.
This is in Pascals.
Definition at line 19 of file pressure.cc.
|
inline |
Return the current surface pressure value, without the gradient.
This is in Pascals.
Definition at line 48 of file pressure.h.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
