 |
ReFRACtor
|
|
ReFRACtor
|
This class maintains the aerosol portion of the state. More...
#include <aerosol.h>
Inheritance diagram for FullPhysics::Aerosol: Collaboration diagram for FullPhysics::Aerosol:Public Member Functions | |
| virtual | ~Aerosol () |
| virtual void | add_observer (Observer< Aerosol > &Obs) |
| Add an observer. More... | |
| void | add_observer_and_keep_reference (boost::shared_ptr< Observer< Aerosol > > &Obs) |
| Add an observer and keep a reference to it. More... | |
| virtual boost::shared_ptr< Aerosol > | clone () const =0 |
| virtual boost::shared_ptr< Aerosol > | clone (const boost::shared_ptr< Pressure > &Press, const boost::shared_ptr< RelativeHumidity > &Rh) const =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 | 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_particle () const =0 |
| Number of aerosol particles. More... | |
| virtual ArrayAd< double, 2 > | optical_depth_each_layer (double wn) const =0 |
| This gives the optical depth for each layer, for the given wave number. More... | |
| virtual ArrayAd< double, 3 > | pf_mom (double wn, const ArrayAd< double, 2 > &frac_aer, int nummom=-1, int numscat=-1) const =0 |
| This calculates the portion of the phase function moments that come from the aerosol. More... | |
| virtual void | print (std::ostream &Os) const |
| std::string | print_to_string () const |
| Print to string. More... | |
| virtual void | remove_observer (Observer< Aerosol > &Obs) |
| Remove an observer. More... | |
| virtual ArrayAd< double, 1 > | ssa_each_layer (double wn, int particle_index, const ArrayAd< double, 1 > &Od) const =0 |
| This gives the single scatter albedo for each layer, for the given wave number, for the given particle. 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... | |
Static Public Attributes | |
| static AccumulatedTimer | timer |
| Timer for Aerosol. More... | |
Protected Member Functions | |
| void | add_observer_do (Observer< Aerosol > &Obs, Aerosol &t) |
| Add an observer. More... | |
| void | add_observer_do (Observer< Aerosol > &Obs) |
| void | clean_dead_ptr () |
| Remove any dead pointers. More... | |
| void | notify_update_do (const Aerosol &Self) |
| Function to call to notify Observers of a state change. More... | |
| void | remove_observer_do (Observer< Aerosol > &Obs, Aerosol &t) |
| Remove an observer. More... | |
| void | remove_observer_do (Observer< Aerosol > &Obs) |
Protected Attributes | |
| std::list< boost::weak_ptr< Observer< Aerosol > > > | olist |
| std::vector< boost::shared_ptr< Observer< Aerosol > > > | ref_list |
This class maintains the aerosol portion of the state.
Other objects may depend on the aerosol, and should be updated when the aerosol is updated. To facilitate that, this class in an Oberverable, and objects can add themselves as Observers to be notified when the aerosol is updated.
I'm not really sure what the interface for this class should be. Right now it is used only by AtmosphereOco, and there is only one instance AerosolOptical, so the functions are what AtmosphereOco needs. But we may perhaps want to modify this in the future to be more general.
Add an observer.
Implements FullPhysics::Observable< Aerosol >.
|
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 |
Implemented in FullPhysics::AerosolOptical.
|
pure virtual |
Implemented in FullPhysics::AerosolOptical.
|
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.
|
pure virtual |
Number of aerosol particles.
Implemented in FullPhysics::AerosolOptical.
|
pure virtual |
This gives the optical depth for each layer, for the given wave number.
Note this only includes the aerosol portion of this, Atmosphere class combines this with Absorbers and rayleigh scattering.
This calculates the derivatives with respect to the state vector.
This has size of number_active_layer() x number_particle().
Implemented in FullPhysics::AerosolOptical.
|
pure virtual |
This calculates the portion of the phase function moments that come from the aerosol.
| wn | The wave number. |
| frac_aer | This is number_active_layer() x number_particle() |
| nummom | Number of moments to fill in |
| numscat | Number of scatters to fill in |
Implemented in FullPhysics::AerosolOptical.
|
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< Aerosol >.
|
inlineprotectedinherited |
Remove an observer.
Definition at line 173 of file observer.h.
|
inlineprotectedinherited |
Definition at line 181 of file observer.h.
|
pure virtual |
This gives the single scatter albedo for each layer, for the given wave number, for the given particle.
Note this only includes the aerosol portion of this, Atmosphere class combines this with Rayleigh scattering.
We take in the optical depth of each layer. This is just what is returned by optical_depth_each_layer(), we take this in because we can change what the derivative of optical_depth_each_layer is respect to, e.g. in AtmosphereOco we use taua_i.
This calculates the derivative with respect to whatever variables Od is relative to.
This has size of number_active_layer()
Implemented in FullPhysics::AerosolOptical.
|
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.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
|
static |
