ReFRACtor
|
This class maintains the pressure portion of the state. More...
#include <pressure_fixed_level.h>
Public Member Functions | |
PressureFixedLevel (bool Pressure_flag, const boost::shared_ptr< PressureLevelInput > &Press_level, double Surface_pressure) | |
virtual | ~PressureFixedLevel () |
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 |
Clone a PressureFixedLevel object. More... | |
const ArrayAd< double, 1 > & | coefficient () const |
virtual std::string | desc () const |
Description of object, to be printed to stream. More... | |
void | init (const blitz::Array< double, 1 > &Coeff, const blitz::Array< bool, 1 > &Used_flag, const boost::shared_ptr< Pressure > &Press=boost::shared_ptr< Pressure >(), bool Mark_according_to_press=true, int Pdep_start=0) |
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 | 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... | |
void | mark_used_sub (blitz::Array< bool, 1 > &Used) const |
Called by mark_used with the subset of the state vector used by this class. More... | |
int | max_number_level () const |
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_add (StateVector &Sv) |
Called when an object is added to an Observable. More... | |
virtual void | notify_remove (StateVector &Observed_object) |
Called when an object is removed from an Observable. More... | |
virtual void | notify_remove () |
virtual void | notify_remove (StateVector &Sv) |
Called when an object is removed from an Observable. More... | |
virtual void | notify_update (const StateVector &Sv) |
Called when the Observed object is updated. More... | |
virtual void | notify_update (const StateVector &Observed_object) |
Called when the Observed object is updated. More... | |
int | number_active_layer () const |
Number of active layers. More... | |
int | number_active_level () const |
Number of active levels, this is just the size of pressure_grid for the current surface pressure. More... | |
int | number_layer () const |
This is the number of layers. More... | |
int | number_level () const |
This is the number of levels. More... | |
const boost::shared_ptr< Pressure > & | pressure () const |
blitz::Array< double, 1 > | pressure_active_levels () const |
Return the pressure on the fixed levels, but only include the "active" portion. More... | |
virtual ArrayAdWithUnit< double, 1 > | pressure_grid () const |
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 |
Print to stream. More... | |
std::string | print_to_string () const |
Print to string. More... | |
virtual void | remove_observer (Observer< Pressure > &Obs) |
Remove an observer. More... | |
void | set_surface_pressure (const AutoDerivative< double > &Surface_pressure) |
Set the surface pressure. This is in Pascals. 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 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 std::string | state_vector_name_i (int i) const |
Return state vector name for ith entry in coeff. More... | |
virtual void | state_vector_name_sub (blitz::Array< std::string, 1 > &Sv_name) const |
Called by state_vector_name with the subset of the Sv_name used by this class. More... | |
int | state_vector_start_index () const |
Starting index of state vector used by this object. More... | |
const blitz::Array< double, 2 > & | statevector_covariance () const |
virtual std::string | sub_state_identifier () const |
Return a string to identify this part of the state, this name should be all lower case and seperate parts with a /. More... | |
int | sub_vector_size () const |
Length of the sub set of the state vector used by 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_uncertainty () const |
Return the current surface pressure uncertainty. This is in Pascals. More... | |
double | surface_pressure_value () const |
Return the current surface pressure value, without the gradient. More... | |
virtual void | update_sub_state (const ArrayAd< double, 1 > &Sv_sub, const blitz::Array< double, 2 > &Cov) |
Called by update_state with the subset of the state vector used by this class. More... | |
virtual void | update_sub_state_hook () |
Hook for anything a derived class needs to do after coefficient is updated and before notify_update. More... | |
const blitz::Array< bool, 1 > & | used_flag_value () const |
Static Public Attributes | |
static const double | new_level_fractional_size = .20 |
Size a new level must be in porportion to the layer above it when resizing pressure grid due to moved surface pressure. More... | |
Protected Member Functions | |
void | add_observer_do (Observer< Pressure > &Obs, Pressure &t) |
Add an observer. More... | |
void | add_observer_do (Observer< Pressure > &Obs) |
virtual void | calc_pressure_grid () const |
Calculate the new pressure grid. More... | |
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) |
void | state_vector_observer_initialize (int Plen) |
Take the given number of state vector parameters. More... | |
Protected Attributes | |
bool | cache_stale |
If this is true, the recalculate the pressure_grid the next time we need it. More... | |
ArrayAd< double, 1 > | coeff |
Coefficients. More... | |
blitz::Array< double, 2 > | cov |
Last covariance matrix updated from the StateVector. More... | |
bool | mark_according_to_press |
Flag indicating if we only mark coefficients >= pdep_start + press->number_level() in mark_used_sub. More... | |
std::list< boost::weak_ptr< Observer< Pressure > > > | olist |
int | pdep_start |
Index of first coefficient that depends on the number of pressure levels. More... | |
ArrayAdWithUnit< double, 1 > | pgrid |
The cached pressure grid. More... | |
boost::shared_ptr< Pressure > | press |
Pressure. More... | |
std::vector< boost::shared_ptr< Observer< Pressure > > > | ref_list |
blitz::Array< double, 2 > | sv_cov_full |
The last full covariance matrix we have been with, saved for reference by derived class. More... | |
blitz::Array< double, 2 > | sv_cov_sub |
The subset of cov_full that is "owned" by this class, what was passed through update_sub_state. More... | |
ArrayAd< double, 1 > | sv_full |
The last full state vector we have been updated with, saved for reference by derived class. More... | |
ArrayAd< double, 1 > | sv_sub |
The subset of sv_full that is "owned" by this class, what was passed through update_sub_state. More... | |
blitz::Array< bool, 1 > | used_flag |
Flag indicating which of the coefficients gets updated by the StateVector. More... | |
This class maintains the pressure portion of the state.
This particular implementation has a fixed set of pressure levels, with only the surface pressure changing. As the surface pressure changes, it may pass a pressure level, changing the number of levels that lie above the surface.
Definition at line 17 of file pressure_fixed_level.h.
|
inline |
Definition at line 19 of file pressure_fixed_level.h.
|
inlinevirtual |
Definition at line 32 of file pressure_fixed_level.h.
|
inlinevirtualinherited |
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.
|
protectedvirtual |
Calculate the new pressure grid.
Done each time the surface pressure is updated.
Implements FullPhysics::PressureImpBase.
Definition at line 28 of file pressure_fixed_level.cc.
|
inlineprotectedinherited |
Remove any dead pointers.
Definition at line 196 of file observer.h.
|
virtual |
Clone a PressureFixedLevel object.
Note that the cloned version will not be attached to a StateVector or Observer<PressureFixedLevel>, although you can of course attach them after receiving the cloned object.
Implements FullPhysics::PressureImpBase.
Definition at line 64 of file pressure_fixed_level.cc.
|
inlineinherited |
Definition at line 171 of file sub_state_vector_array.h.
|
inlinevirtualinherited |
Description of object, to be printed to stream.
This gives a cleaner interface for deriving from python.
Definition at line 47 of file pressure_imp_base.h.
|
inlineinherited |
Definition at line 59 of file sub_state_vector_array.h.
|
virtualinherited |
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 from FullPhysics::StateVectorObserver.
Definition at line 35 of file sub_state_vector_observer.cc.
|
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 by mark_used with the subset of the state vector used by this class.
The default marks everything as used, but derived classes can override this.
Reimplemented from FullPhysics::SubStateVectorObserver.
Definition at line 91 of file sub_state_vector_array.h.
|
inlinevirtual |
Maximum number of levels that we can have.
Reimplemented from FullPhysics::Pressure.
Definition at line 76 of file pressure_fixed_level.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 added to an Observable.
Default is to do nothing.
Reimplemented from FullPhysics::Observer< StateVector >.
Definition at line 60 of file sub_state_vector_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 an object is removed from an Observable.
Default is to do nothing.
Reimplemented from FullPhysics::Observer< StateVector >.
Definition at line 68 of file sub_state_vector_observer.h.
|
virtualinherited |
Called when the Observed object is updated.
Reimplemented from FullPhysics::Observer< StateVector >.
Reimplemented in FullPhysics::RadianceScalingSvFit.
Definition at line 6 of file sub_state_vector_observer.cc.
|
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 |
Number of active layers.
This is 1 less than the number of levels, since the levels give the top an bottom of a layer.
Definition at line 68 of file pressure_fixed_level.h.
|
inline |
Number of active levels, this is just the size of pressure_grid for the current surface pressure.
Definition at line 60 of file pressure_fixed_level.h.
|
inlineinherited |
This is the number of layers.
This is the same as pressure_grid.rows() - 1.
Definition at line 64 of file pressure.h.
|
inlineinherited |
This is the number of levels.
This is the same as pressure_grid.rows() - 1.
Definition at line 71 of file pressure.h.
|
inlineinherited |
Definition at line 186 of file sub_state_vector_array.h.
|
inline |
Return the pressure on the fixed levels, but only include the "active" portion.
This is all the pressure levels above the surface, plus the last one at or below the surface. This is the same size as pressure_grid, but differs in that the bottom level typically lies below the surface
Definition at line 86 of file pressure_fixed_level.h.
|
inlinevirtualinherited |
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.
Implements FullPhysics::Pressure.
Definition at line 29 of file pressure_imp_base.h.
|
virtual |
Print to stream.
The default calls the function "desc" that returns a string. This gives cleaner interface for deriving from this class in python, but most C++ classes will want to override this function rather than using desc.
Reimplemented from FullPhysics::PressureImpBase.
Definition at line 72 of file pressure_fixed_level.cc.
|
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.
|
inlinevirtualinherited |
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.
|
inline |
Set the surface pressure. This is in Pascals.
Definition at line 45 of file pressure_fixed_level.h.
|
virtualinherited |
Update any portion of the list of the state vector names that apply to this object.
Default is to do nothing.
Reimplemented from FullPhysics::StateVectorObserver.
Definition at line 52 of file sub_state_vector_observer.cc.
|
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.
|
inlinevirtual |
Return state vector name for ith entry in coeff.
Reimplemented from FullPhysics::SubStateVectorArray< Pressure >.
Definition at line 96 of file pressure_fixed_level.h.
|
inlinevirtualinherited |
Called by state_vector_name with the subset of the Sv_name used by this class.
The default function doesn't change anything, but derived classes can ovveride this.
Reimplemented from FullPhysics::SubStateVectorObserver.
Definition at line 134 of file sub_state_vector_array.h.
|
protectedinherited |
Take the given number of state vector parameters.
We determine where the starting point to use is when we attach to the state vector.
Note that it is perfectly legal for Plen to be 0, that just means we don't have any parameters. This is a useful edge case that we support.
Definition at line 80 of file sub_state_vector_observer.cc.
|
inlineinherited |
Starting index of state vector used by this object.
Definition at line 25 of file sub_state_vector_observer.h.
|
inlineinherited |
Definition at line 181 of file sub_state_vector_array.h.
|
inlinevirtual |
Return a string to identify this part of the state, this name should be all lower case and seperate parts with a /.
For example, an aerosol named strat would be named as: aerosol/strat. A gas named CO2 would be named like this: absorber/co2 The name is intended to be used for looking up retrieval values for a configuration system. Classes that have the same type of inputs should have the same name.
Reimplemented from FullPhysics::SubStateVectorArray< Pressure >.
Definition at line 94 of file pressure_fixed_level.h.
|
inlineinherited |
Length of the sub set of the state vector used by this object.
Definition at line 31 of file sub_state_vector_observer.h.
|
inherited |
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 uncertainty. This is in Pascals.
Definition at line 38 of file pressure_fixed_level.h.
|
inlineinherited |
Return the current surface pressure value, without the gradient.
This is in Pascals.
Definition at line 48 of file pressure.h.
|
inlinevirtualinherited |
Called by update_state with the subset of the state vector used by this class.
Implements FullPhysics::SubStateVectorObserver.
Definition at line 145 of file sub_state_vector_array.h.
|
inlinevirtualinherited |
Hook for anything a derived class needs to do after coefficient is updated and before notify_update.
Default is nothing.
Reimplemented from FullPhysics::SubStateVectorArray< Pressure >.
Definition at line 32 of file pressure_imp_base.h.
|
inlineinherited |
Definition at line 176 of file sub_state_vector_array.h.
|
mutableprotectedinherited |
If this is true, the recalculate the pressure_grid the next time we need it.
Definition at line 53 of file pressure_imp_base.h.
|
protectedinherited |
Coefficients.
Definition at line 196 of file sub_state_vector_array.h.
|
protectedinherited |
Last covariance matrix updated from the StateVector.
If we haven't updated yet, this will be a 0x0 array.
Definition at line 216 of file sub_state_vector_array.h.
|
protectedinherited |
Flag indicating if we only mark coefficients >= pdep_start + press->number_level() in mark_used_sub.
This may seem a bit arcane, but this matches some of the classes that derive from this one (e.g., TemperatureFixedLevel).
Definition at line 225 of file sub_state_vector_array.h.
|
static |
Size a new level must be in porportion to the layer above it when resizing pressure grid due to moved surface pressure.
Helps prevent small layers causing over representitive VMR values in porportion to a layer size.
Definition at line 70 of file pressure_fixed_level.h.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Index of first coefficient that depends on the number of pressure levels.
This is only used if mark_according_to_press to true, otherwise we don't do anything with this value.
Definition at line 233 of file sub_state_vector_array.h.
|
mutableprotectedinherited |
The cached pressure grid.
This should be filled in by derived classes when calc_pressure_grid() is called.
Definition at line 59 of file pressure_imp_base.h.
|
protectedinherited |
This may be a null pointer, which just means this particular class doesn't store the Pressure object.
Definition at line 203 of file sub_state_vector_array.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
|
protectedinherited |
The last full covariance matrix we have been with, saved for reference by derived class.
Definition at line 108 of file sub_state_vector_observer.h.
|
protectedinherited |
The subset of cov_full that is "owned" by this class, what was passed through update_sub_state.
Saved for reference by derived class.
Definition at line 122 of file sub_state_vector_observer.h.
|
protectedinherited |
The last full state vector we have been updated with, saved for reference by derived class.
Definition at line 102 of file sub_state_vector_observer.h.
|
protectedinherited |
The subset of sv_full that is "owned" by this class, what was passed through update_sub_state.
Saved for reference by derived class.
Definition at line 115 of file sub_state_vector_observer.h.
|
protectedinherited |
Flag indicating which of the coefficients gets updated by the StateVector.
Definition at line 210 of file sub_state_vector_array.h.