FullPhysics::AtmosphereOco Class Reference

This class maintains the atmosphere portion of the state, and uses this to set up the atmosphere and ground information needed to run the Radiative transfer code. More...

#include <atmosphere_oco.h>

Inheritance diagram for FullPhysics::AtmosphereOco:

Collaboration diagram for FullPhysics::AtmosphereOco:

Public Member Functions
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< Aerosol > &aerosolv, const boost::shared_ptr< RelativeHumidity > &rhv, const boost::shared_ptr< Ground > &groundv, const boost::shared_ptr< SurfaceTemperature > &surface_tempv, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an an Atmosphere with all available components: More...
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< Aerosol > &aerosolv, const boost::shared_ptr< RelativeHumidity > &rhv, const boost::shared_ptr< Ground > &groundv, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an Atmosphere with required components and all optional components except for surface temperature. More...
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< Aerosol > &aerosolv, const boost::shared_ptr< RelativeHumidity > &rhv, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an Atmosphere with required components and all optional components except for ground and surface temperature. More...
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< RelativeHumidity > &rhv, const boost::shared_ptr< Ground > &groundv, const boost::shared_ptr< SurfaceTemperature > &surface_tempv, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an Atmosphere with required components and all optional components except for aerosol More...
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< RelativeHumidity > &rhv, const boost::shared_ptr< Ground > &groundv, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an Atmosphere with required components and all optional components except for aerosol and surface temperature More...
	AtmosphereOco (const boost::shared_ptr< Absorber > &absorberv, const boost::shared_ptr< Pressure > &pressurev, const boost::shared_ptr< Temperature > &temperaturev, const boost::shared_ptr< RelativeHumidity > &Rh, const std::vector< boost::shared_ptr< Altitude > > &altv, const boost::shared_ptr< Constant > &C)
	Create an Atmosphere with required components and all optional components except for ground, aerosol and surface temperature. More...
virtual	~AtmosphereOco ()
const boost::shared_ptr< Absorber > &	absorber_ptr () const
virtual void	add_observer (Observer< RtAtmosphere > &Obs)
	Add an observer. More...
void	add_observer_and_keep_reference (boost::shared_ptr< Observer< RtAtmosphere > > &Obs)
	Add an observer and keep a reference to it. More...
const boost::shared_ptr< Aerosol > &	aerosol_ptr () const
virtual ArrayAdWithUnit< double, 1 >	altitude (int spec_index) const
	Altitude grid for current pressure grid. More...
const std::vector< boost::shared_ptr< Altitude > > &	altitude_ptr () const
const boost::shared_ptr< Altitude > &	altitude_ptr (int Spec_index) const
virtual ArrayAd< double, 1 >	atmosphere_blackbody (double wn, int spec_index) const
	The atmospheric thermal blackbody values per level. More...
void	attach_children_to_sv (StateVector &statev)
	For unit test purposes, it is useful to be able to clone or create a new atmosphere class then attach all its nested children to the state vector in the historic order and in the manner done by the Lua configuration. More...
boost::shared_ptr< AtmosphereOco >	clone () const
	This clones a Atmosphere object. More...
virtual AutoDerivative< double >	column_optical_depth (double wn, int spec_index, const std::string &Gas_name) const
	Total column optical depth for the given gas. More...
virtual boost::shared_ptr< ArrayAdCache< double, double, 1 > > &	column_optical_depth_cache ()
const boost::shared_ptr< Constant > &	constant_ptr () const
virtual const boost::shared_ptr< Ground >	ground () const
	Object that represents the ground surface. More...
virtual ArrayAd< double, 2 >	intermediate_variable (double wn, int spec_index) const
	This gives the values of the intermediate variables and the Jacobian with respect to the state vector. 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 (Aerosol &Observed_object)
	Called when an object is added to an Observable. More...
virtual void	notify_add (Pressure &Observed_object)
	Called when an object is added to an Observable. More...
virtual void	notify_add ()
virtual void	notify_add ()
virtual void	notify_add ()
virtual void	notify_add (StateVector &Sv)
	Called when an object is added to an Observable. More...
virtual void	notify_remove (Aerosol &Observed_object)
	Called when an object is removed from an Observable. More...
virtual void	notify_remove (Pressure &Observed_object)
	Called when an object is removed from an Observable. More...
virtual void	notify_remove ()
virtual void	notify_remove ()
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 Aerosol &A)
	For performance, we cache some data as we calculate it. More...
virtual void	notify_update (const Pressure &P)
	Called when the Observed object is updated. More...
virtual int	number_layer () const
	Number of layers we currently have. More...
virtual int	number_spectrometer () const
	Number of spectrometers we have. More...
virtual ArrayAd< double, 1 >	optical_depth_wrt_iv (double wn, int spec_index) const
	The optical depth for each layer, for the given wave number. More...
virtual ArrayAd< double, 1 >	optical_depth_wrt_iv (double wn, int spec_index, const ArrayAd< double, 2 > &iv) const
	This is a variation of optical_depth that takes the supplied value for the intermediate variables rather than calculating it own value. More...
ArrayAd< double, 1 >	optical_depth_wrt_state_vector (double wn, int spec_index) const
	The optical depth for each layer, for the given wave number. More...
const boost::shared_ptr< Pressure > &	pressure_ptr () const
virtual void	print (std::ostream &Os) const
std::string	print_to_string () const
	Print to string. More...
bool	rayleigh_only_atmosphere () const
	Indicate we have rayleigh only atmosphere, i.e., we don't have any aerosol content. More...
const boost::shared_ptr< Rayleigh > &	rayleigh_ptr () const
const boost::shared_ptr< RelativeHumidity > &	relative_humidity_ptr () const
virtual void	remove_observer (Observer< RtAtmosphere > &Obs)
	Remove an observer. More...
virtual void	reset_timer ()
	Reset timer. More...
virtual ArrayAd< double, 3 >	scattering_moment_wrt_iv (double wn, int spec_index, int nummom=-1, int numscat=-1) const
	The scattering moments for for each layer, for the given wave number. More...
virtual ArrayAd< double, 3 >	scattering_moment_wrt_iv (double wn, int spec_index, const ArrayAd< double, 2 > &iv, int nummom=-1, int numscat=-1) const
	This is a variation of scattering_moment that takes the supplied value for the intermediate variables rather than calculating it own value. More...
ArrayAd< double, 3 >	scattering_moment_wrt_state_vector (double wn, int spec_index, int nummom=-1, int numscat=-1) const
	The scattering moments for for each layer, for the given wave number. More...
void	set_aerosol (boost::shared_ptr< Aerosol > &new_aerosol, StateVector &Sv)
	Changes the aerosol class used. More...
void	set_surface_pressure_for_testing (double x)
	For unit test purposes, it is useful to be able to directly change the surface pressure. More...
virtual ArrayAd< double, 1 >	single_scattering_albedo_wrt_iv (double wn, int spec_index) const
	The single scattering albedo for each layer, for the given wave number. More...
virtual ArrayAd< double, 1 >	single_scattering_albedo_wrt_iv (double wn, int spec_index, const ArrayAd< double, 2 > &iv) const
	This is a variation of single_scattering_albedo that takes the supplied value for the intermediate variables rather than calculating it own value. More...
ArrayAd< double, 1 >	single_scattering_albedo_wrt_state_vector (double wn, int spec_index) const
	The single scattering albedo for each layer, for the given wave number. 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 >	surface_blackbody (double wn, int spec_index) const
	The surface thermal blackbody. More...
const boost::shared_ptr< Temperature > &	temperature_ptr () const
virtual std::string	timer_info () const
	Return timer information. More...

Static Public Attributes
static AccumulatedTimer	timer
	Timer for RtAtmosphere. More...

Protected Member Functions
void	add_observer_do (Observer< RtAtmosphere > &Obs, RtAtmosphere &t)
	Add an observer. More...
void	add_observer_do (Observer< RtAtmosphere > &Obs)
void	clean_dead_ptr ()
	Remove any dead pointers. More...
void	notify_update_do (const RtAtmosphere &Self)
	Function to call to notify Observers of a state change. More...
void	remove_observer_do (Observer< RtAtmosphere > &Obs, RtAtmosphere &t)
	Remove an observer. More...
void	remove_observer_do (Observer< RtAtmosphere > &Obs)

Protected Attributes
std::list< boost::weak_ptr< Observer< RtAtmosphere > > >	olist
std::vector< boost::shared_ptr< Observer< RtAtmosphere > > >	ref_list

Detailed Description

This class maintains the atmosphere portion of the state, and uses this to set up the atmosphere and ground information needed to run the Radiative transfer code.

This particular implementation forwards most of the work to other classes such as Absorber and Aerosol. This class then coordinates these other classes, and provides the calculations needed to set up the RT code.

For some set ups, aerosol_ptr and/or ground_ptr may be null. For a Rayleigh only atmosphere, we don't have any aerosol to include. For up looking (e.g., TCCON FTS), there is no ground portion included in the radiative transfer.

To speed up the calculation of the Jacobian in LIDORT, we make use of "intermediate" variables instead of directly using state vector variables. A description of this in more detail can be found in doc/LIDORT_Jacobian.pdf

Definition at line 36 of file atmosphere_oco.h.

Constructor & Destructor Documentation

AtmosphereOco() [1/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< Aerosol > &	aerosolv,
		const boost::shared_ptr< RelativeHumidity > &	rhv,
		const boost::shared_ptr< Ground > &	groundv,
		const boost::shared_ptr< SurfaceTemperature > &	surface_tempv,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an an Atmosphere with all available components:

Required:

• Pressure
• Temperature
• Relative Humdity
• Altitude

Optional:

• Aerosol
• Ground
• Surface temperature

Definition at line 75 of file atmosphere_oco.cc.

AtmosphereOco() [2/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< Aerosol > &	aerosolv,
		const boost::shared_ptr< RelativeHumidity > &	rhv,
		const boost::shared_ptr< Ground > &	groundv,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an Atmosphere with required components and all optional components except for surface temperature.

Definition at line 100 of file atmosphere_oco.cc.

AtmosphereOco() [3/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< Aerosol > &	aerosolv,
		const boost::shared_ptr< RelativeHumidity > &	rhv,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an Atmosphere with required components and all optional components except for ground and surface temperature.

---

Definition at line 124 of file atmosphere_oco.cc.

AtmosphereOco() [4/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< RelativeHumidity > &	rhv,
		const boost::shared_ptr< Ground > &	groundv,
		const boost::shared_ptr< SurfaceTemperature > &	surface_tempv,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an Atmosphere with required components and all optional

components except for aerosol

Definition at line 147 of file atmosphere_oco.cc.

AtmosphereOco() [5/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< RelativeHumidity > &	rhv,
		const boost::shared_ptr< Ground > &	groundv,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an Atmosphere with required components and all optional

components except for aerosol and surface temperature

Definition at line 171 of file atmosphere_oco.cc.

AtmosphereOco() [6/6]

AtmosphereOco::AtmosphereOco	(	const boost::shared_ptr< Absorber > &	absorberv,
		const boost::shared_ptr< Pressure > &	pressurev,
		const boost::shared_ptr< Temperature > &	temperaturev,
		const boost::shared_ptr< RelativeHumidity > &	Rh,
		const std::vector< boost::shared_ptr< Altitude > > &	altv,
		const boost::shared_ptr< Constant > &	C
	)

Create an Atmosphere with required components and all optional components except for ground, aerosol and surface temperature.

Definition at line 194 of file atmosphere_oco.cc.

~AtmosphereOco()

virtual FullPhysics::AtmosphereOco::~AtmosphereOco ( )

inlinevirtual

Definition at line 97 of file atmosphere_oco.h.

Member Function Documentation

absorber_ptr()

const boost::shared_ptr<Absorber>& FullPhysics::AtmosphereOco::absorber_ptr ( ) const

inline

Definition at line 202 of file atmosphere_oco.h.

add_observer()

virtual void FullPhysics::RtAtmosphere::add_observer ( Observer< RtAtmosphere > &  Obs )

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< RtAtmosphere >.

Definition at line 56 of file rt_atmosphere.h.

add_observer_and_keep_reference()

void FullPhysics::Observable< RtAtmosphere >::add_observer_and_keep_reference ( boost::shared_ptr< Observer< RtAtmosphere > > &  Obs )

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.

add_observer_do() [1/2]

void FullPhysics::Observable< RtAtmosphere >::add_observer_do ( Observer< RtAtmosphere > &  Obs, RtAtmosphere &  t  )

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

add_observer_do() [2/2]

void FullPhysics::Observable< RtAtmosphere >::add_observer_do ( Observer< RtAtmosphere > &  Obs )

inlineprotectedinherited

Definition at line 159 of file observer.h.

aerosol_ptr()

const boost::shared_ptr<Aerosol>& FullPhysics::AtmosphereOco::aerosol_ptr ( ) const

inline

Definition at line 205 of file atmosphere_oco.h.

altitude()

ArrayAdWithUnit< double, 1 > AtmosphereOco::altitude ( int  spec_index ) const

virtual

Altitude grid for current pressure grid.

Implements FullPhysics::RtAtmosphere.

Definition at line 530 of file atmosphere_oco.cc.

altitude_ptr() [1/2]

const std::vector<boost::shared_ptr<Altitude> >& FullPhysics::AtmosphereOco::altitude_ptr ( ) const

inline

Definition at line 211 of file atmosphere_oco.h.

altitude_ptr() [2/2]

const boost::shared_ptr<Altitude>& FullPhysics::AtmosphereOco::altitude_ptr ( int  Spec_index ) const

inline

Definition at line 213 of file atmosphere_oco.h.

atmosphere_blackbody()

ArrayAd< double, 1 > AtmosphereOco::atmosphere_blackbody ( double  wn, int  spec_index  ) const

virtual

The atmospheric thermal blackbody values per level.

Implements FullPhysics::RtAtmosphere.

Definition at line 545 of file atmosphere_oco.cc.

attach_children_to_sv()

void AtmosphereOco::attach_children_to_sv

(

StateVector &

statev

)

For unit test purposes, it is useful to be able to clone or create a new atmosphere class then attach all its nested children to the state vector in the historic order and in the manner done by the Lua configuration.

Definition at line 675 of file atmosphere_oco.cc.

clean_dead_ptr()

void FullPhysics::Observable< RtAtmosphere >::clean_dead_ptr ( )

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

clone()

boost::shared_ptr< AtmosphereOco > AtmosphereOco::clone

(

)

const

This clones a Atmosphere object.

This is a deep copy, all of the objects that are part of this are cloned also (e.g., Pressure, Temperature).

This cloned copy will not be attached to any StateVector, nor will any Observer<Atmosphere> objects be attached (although the original object is unchanged). You can attach the clone to any objects you wish to.

This property is particularly useful to "freeze" the state. For example, if the StateVector was set the apriori state and the Atmosphere attached to the StateVector is cloned, then the cloned version will continue to be the "Apriori atmosphere", even if the StateVector is subsequently changed thus updating the original object.

Definition at line 594 of file atmosphere_oco.cc.

column_optical_depth()

virtual AutoDerivative<double> FullPhysics::AtmosphereOco::column_optical_depth ( double  wn, int  spec_index, const std::string &  Gas_name  ) const

inlinevirtual

Total column optical depth for the given gas.

This is 0 if the band isn't one that sees that gas.

Implements FullPhysics::RtAtmosphere.

Definition at line 107 of file atmosphere_oco.h.

column_optical_depth_cache()

virtual boost::shared_ptr<ArrayAdCache<double, double, 1> >& FullPhysics::AtmosphereOco::column_optical_depth_cache ( )

inlinevirtual

Definition at line 119 of file atmosphere_oco.h.

constant_ptr()

const boost::shared_ptr<Constant>& FullPhysics::AtmosphereOco::constant_ptr ( ) const

inline

Definition at line 209 of file atmosphere_oco.h.

ground()

virtual const boost::shared_ptr<Ground> FullPhysics::AtmosphereOco::ground ( ) const

inlinevirtual

Object that represents the ground surface.

If null then there is no surface for this atmosphere.

Implements FullPhysics::RtAtmosphere.

Definition at line 182 of file atmosphere_oco.h.

intermediate_variable()

virtual ArrayAd<double, 2> FullPhysics::AtmosphereOco::intermediate_variable ( double  wn, int  spec_index  ) const

inlinevirtual

This gives the values of the intermediate variables and the Jacobian with respect to the state vector.

This is number_layer() x number variables

Implements FullPhysics::RtAtmosphere.

Definition at line 176 of file atmosphere_oco.h.

mark_used()

virtual void FullPhysics::StateVectorObserver::mark_used ( const StateVector &  Sv, blitz::Array< bool, 1 > &  Used  ) const

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.

notify_add() [1/6]

virtual void FullPhysics::Observer< Aerosol >::notify_add ( Aerosol &  Observed_object )

inlinevirtualinherited

Called when an object is added to an Observable.

Default is to do nothing.

Definition at line 47 of file observer.h.

notify_add() [2/6]

virtual void FullPhysics::Observer< Pressure >::notify_add ( Pressure &  Observed_object )

inlinevirtualinherited

Called when an object is added to an Observable.

Default is to do nothing.

Definition at line 47 of file observer.h.

notify_add() [3/6]

virtual void FullPhysics::Observer< StateVector >::notify_add ( )

inlinevirtualinherited

Definition at line 48 of file observer.h.

notify_add() [4/6]

virtual void FullPhysics::Observer< Pressure >::notify_add ( )

inlinevirtualinherited

Definition at line 48 of file observer.h.

notify_add() [5/6]

virtual void FullPhysics::Observer< Aerosol >::notify_add ( )

inlinevirtualinherited

Definition at line 48 of file observer.h.

notify_add() [6/6]

virtual void FullPhysics::AtmosphereOco::notify_add ( StateVector &  Observed_object )

inlinevirtual

Called when an object is added to an Observable.

Default is to do nothing.

Reimplemented from FullPhysics::Observer< StateVector >.

Definition at line 186 of file atmosphere_oco.h.

notify_remove() [1/6]

virtual void FullPhysics::Observer< Pressure >::notify_remove ( Pressure &  Observed_object )

inlinevirtualinherited

Called when an object is removed from an Observable.

Default is to do nothing.

Definition at line 55 of file observer.h.

notify_remove() [2/6]

virtual void FullPhysics::Observer< Aerosol >::notify_remove ( Aerosol &  Observed_object )

inlinevirtualinherited

Called when an object is removed from an Observable.

Default is to do nothing.

Definition at line 55 of file observer.h.

notify_remove() [3/6]

virtual void FullPhysics::Observer< Aerosol >::notify_remove ( )

inlinevirtualinherited

Definition at line 56 of file observer.h.

notify_remove() [4/6]

virtual void FullPhysics::Observer< StateVector >::notify_remove ( )

inlinevirtualinherited

Definition at line 56 of file observer.h.

notify_remove() [5/6]

virtual void FullPhysics::Observer< Pressure >::notify_remove ( )

inlinevirtualinherited

Definition at line 56 of file observer.h.

notify_remove() [6/6]

virtual void FullPhysics::AtmosphereOco::notify_remove ( StateVector &  Observed_object )

inlinevirtual

Called when an object is removed from an Observable.

Default is to do nothing.

Reimplemented from FullPhysics::Observer< StateVector >.

Definition at line 188 of file atmosphere_oco.h.

notify_update() [1/3]

virtual void FullPhysics::AtmosphereOco::notify_update ( const StateVector &  Observed_object )

inlinevirtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< StateVector >.

Definition at line 190 of file atmosphere_oco.h.

notify_update() [2/3]

void AtmosphereOco::notify_update ( const Aerosol &  A )

virtual

For performance, we cache some data as we calculate it.

This becomes stale when the aerosol is changed, so we observe aerosol and mark the cache when it changes.

Reimplemented from FullPhysics::Observer< Aerosol >.

Definition at line 333 of file atmosphere_oco.cc.

notify_update() [3/3]

virtual void FullPhysics::AtmosphereOco::notify_update ( const Pressure &  Observed_object )

inlinevirtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< Pressure >.

Definition at line 195 of file atmosphere_oco.h.

notify_update_do()

void FullPhysics::Observable< RtAtmosphere >::notify_update_do ( const RtAtmosphere &  Self )

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.

number_layer()

virtual int FullPhysics::AtmosphereOco::number_layer ( ) const

inlinevirtual

Number of layers we currently have.

Implements FullPhysics::RtAtmosphere.

Definition at line 100 of file atmosphere_oco.h.

number_spectrometer()

virtual int FullPhysics::AtmosphereOco::number_spectrometer ( ) const

inlinevirtual

Number of spectrometers we have.

Implements FullPhysics::RtAtmosphere.

Definition at line 99 of file atmosphere_oco.h.

optical_depth_wrt_iv() [1/2]

virtual ArrayAd<double, 1> FullPhysics::AtmosphereOco::optical_depth_wrt_iv ( double  wn, int  spec_index  ) const

inlinevirtual

The optical depth for each layer, for the given wave number.

The derivatives of the optical depth are with respect to the intermediate variables, rather than the state vector variables (see description of RtAtmosphere class for discussion of this).

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index

Returns

Optical depth for each layer. This is number_layer() in size

Implements FullPhysics::RtAtmosphere.

Definition at line 124 of file atmosphere_oco.h.

optical_depth_wrt_iv() [2/2]

virtual ArrayAd<double, 1> FullPhysics::AtmosphereOco::optical_depth_wrt_iv ( double  wn, int  spec_index, const ArrayAd< double, 2 > &  iv  ) const

inlinevirtual

This is a variation of optical_depth that takes the supplied value for the intermediate variables rather than calculating it own value.

This is used by the LSI to get "average optical properties".

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index
iv	Intermediate variable values to use.

Returns

Optical depth for each layer. This is number_layer() in size

Implements FullPhysics::RtAtmosphere.

Definition at line 142 of file atmosphere_oco.h.

optical_depth_wrt_state_vector()

ArrayAd< double, 1 > RtAtmosphere::optical_depth_wrt_state_vector ( double  wn, int  spec_index  ) const

inherited

The optical depth for each layer, for the given wave number.

This variation gives the derivatives with respect to the state vector, this just combines optical_depth with the Jacobian of the intermediate variables given by intermediate_variable.

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index

Returns

Optical depth for each layer. This is number_layer() in size

Definition at line 43 of file rt_atmosphere.cc.

pressure_ptr()

const boost::shared_ptr<Pressure>& FullPhysics::AtmosphereOco::pressure_ptr ( ) const

inline

Definition at line 201 of file atmosphere_oco.h.

print()

void AtmosphereOco::print ( std::ostream &  Os ) const

virtual

Reimplemented from FullPhysics::StateVectorObserver.

Definition at line 620 of file atmosphere_oco.cc.

print_to_string()

std::string FullPhysics::Printable< StateVectorObserver >::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.

rayleigh_only_atmosphere()

bool FullPhysics::AtmosphereOco::rayleigh_only_atmosphere ( ) const

inline

Indicate we have rayleigh only atmosphere, i.e., we don't have any aerosol content.

Definition at line 222 of file atmosphere_oco.h.

rayleigh_ptr()

const boost::shared_ptr<Rayleigh>& FullPhysics::AtmosphereOco::rayleigh_ptr ( ) const

inline

Definition at line 210 of file atmosphere_oco.h.

relative_humidity_ptr()

const boost::shared_ptr<RelativeHumidity>& FullPhysics::AtmosphereOco::relative_humidity_ptr ( ) const

inline

Definition at line 207 of file atmosphere_oco.h.

remove_observer()

virtual void FullPhysics::RtAtmosphere::remove_observer ( Observer< RtAtmosphere > &  Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< RtAtmosphere >.

Definition at line 58 of file rt_atmosphere.h.

remove_observer_do() [1/2]

void FullPhysics::Observable< RtAtmosphere >::remove_observer_do ( Observer< RtAtmosphere > &  Obs, RtAtmosphere &  t  )

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

remove_observer_do() [2/2]

void FullPhysics::Observable< RtAtmosphere >::remove_observer_do ( Observer< RtAtmosphere > &  Obs )

inlineprotectedinherited

Definition at line 181 of file observer.h.

reset_timer()

void AtmosphereOco::reset_timer ( )

virtual

Reset timer.

Reimplemented from FullPhysics::RtAtmosphere.

Definition at line 311 of file atmosphere_oco.cc.

scattering_moment_wrt_iv() [1/2]

virtual ArrayAd<double, 3> FullPhysics::AtmosphereOco::scattering_moment_wrt_iv ( double  wn, int  spec_index, int  nummom = -1, int  numscat = -1  ) const

inlinevirtual

The scattering moments for for each layer, for the given wave number.

The scattering moments use the de Rooij convention for the 6 scattering matrix element.

The derivatives of the optical depth are with respect to the intermediate variables, rather than the state vector variables (see description of RtAtmosphere class for discussion of this).

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index
nummom	Number of moments to include in scatt_mom_each_layer, the default it to include all of them.
numscat	Number of scattering matrix elements to include in scatt_mom_each_layer, the default it to include all of them.

Returns

Scattering moments for each layer. This is number_moment + 1 x number_layer() x number scattering matrix elements

Implements FullPhysics::RtAtmosphere.

Definition at line 136 of file atmosphere_oco.h.

scattering_moment_wrt_iv() [2/2]

virtual ArrayAd<double, 3> FullPhysics::AtmosphereOco::scattering_moment_wrt_iv ( double  wn, int  spec_index, const ArrayAd< double, 2 > &  iv, int  nummom = -1, int  numscat = -1  ) const

inlinevirtual

This is a variation of scattering_moment that takes the supplied value for the intermediate variables rather than calculating it own value.

This is used by the LSI to get "average optical properties".

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index
iv	Intermediate variable values to use.
nummom	Number of moments to include in scatt_mom_each_layer, the default it to include all of them.
numscat	Number of scattering matrix elements to include in scatt_mom_each_layer, the default it to include all of them.

Returns

Scattering moments for each layer. This is number_moment + 1 x number_layer() x number scattering matrix elements

Implements FullPhysics::RtAtmosphere.

Definition at line 158 of file atmosphere_oco.h.

scattering_moment_wrt_state_vector()

ArrayAd< double, 3 > RtAtmosphere::scattering_moment_wrt_state_vector ( double  wn, int  spec_index, int  nummom = -1, int  numscat = -1  ) const

inherited

The scattering moments for for each layer, for the given wave number.

The scattering moments use the de Rooij convention for the 6 scattering matrix element.

This variation gives the derivatives with respect to the state vector, this just combines single_scattering_albedo with the Jacobian of the intermediate variables given by intermediate_variable.

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index
nummom	Number of moments to include in scatt_mom_each_layer, the default it to include all of them.
numscat	Number of scattering matrix elements to include in scatt_mom_each_layer, the default it to include all of them.

Returns

Scattering moments for each layer. This is number_moment + 1 x number_layer() x number scattering matrix elements

Definition at line 114 of file rt_atmosphere.cc.

set_aerosol()

void AtmosphereOco::set_aerosol	(	boost::shared_ptr< Aerosol > &	new_aerosol,
		StateVector &	Sv
	)

Changes the aerosol class used.

Notifies the relevant obsevers and invalidates the cache

Definition at line 233 of file atmosphere_oco.cc.

set_surface_pressure_for_testing()

void AtmosphereOco::set_surface_pressure_for_testing

(

double

x

)

For unit test purposes, it is useful to be able to directly change the surface pressure.

This is intended just for testing purposes. This only works if the Pressure is a PressureFixedLevel, otherwise it will fail.

Definition at line 662 of file atmosphere_oco.cc.

single_scattering_albedo_wrt_iv() [1/2]

virtual ArrayAd<double, 1> FullPhysics::AtmosphereOco::single_scattering_albedo_wrt_iv ( double  wn, int  spec_index  ) const

inlinevirtual

The single scattering albedo for each layer, for the given wave number.

The derivatives of the optical depth are with respect to the intermediate variables, rather than the state vector variables (see description of RtAtmosphere class for discussion of this).

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index

Returns

Single scattering albedo for each layer. This is number_layer() in size

Implements FullPhysics::RtAtmosphere.

Definition at line 130 of file atmosphere_oco.h.

single_scattering_albedo_wrt_iv() [2/2]

virtual ArrayAd<double, 1> FullPhysics::AtmosphereOco::single_scattering_albedo_wrt_iv ( double  wn, int  spec_index, const ArrayAd< double, 2 > &  iv  ) const

inlinevirtual

This is a variation of single_scattering_albedo that takes the supplied value for the intermediate variables rather than calculating it own value.

This is used by the LSI to get "average optical properties".

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index
iv	Intermediate variable values to use.

Returns

Single scattering albedo for each layer. This is number_layer() in size

Implements FullPhysics::RtAtmosphere.

Definition at line 150 of file atmosphere_oco.h.

single_scattering_albedo_wrt_state_vector()

ArrayAd< double, 1 > RtAtmosphere::single_scattering_albedo_wrt_state_vector ( double  wn, int  spec_index  ) const

inherited

The single scattering albedo for each layer, for the given wave number.

This variation gives the derivatives with respect to the state vector, this just combines single_scattering_albedo with the Jacobian of the intermediate variables given by intermediate_variable.

Parameters

wn	The wave number to calculate parameters for.
spec_index	The spectrometer index

Returns

Single scattering albedo for each layer. This is number_layer() in size

Definition at line 73 of file rt_atmosphere.cc.

state_vector_name()

virtual void FullPhysics::StateVectorObserver::state_vector_name ( const StateVector &  Sv, blitz::Array< std::string, 1 > &  Sv_name  ) const

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.

surface_blackbody()

AutoDerivative< double > AtmosphereOco::surface_blackbody ( double  wn, int  spec_index  ) const

virtual

The surface thermal blackbody.

Implements FullPhysics::RtAtmosphere.

Definition at line 563 of file atmosphere_oco.cc.

temperature_ptr()

const boost::shared_ptr<Temperature>& FullPhysics::AtmosphereOco::temperature_ptr ( ) const

inline

Definition at line 203 of file atmosphere_oco.h.

timer_info()

std::string AtmosphereOco::timer_info ( ) const

virtual

Return timer information.

Reimplemented from FullPhysics::RtAtmosphere.

Definition at line 318 of file atmosphere_oco.cc.

Member Data Documentation

olist

std::list<boost::weak_ptr<Observer<RtAtmosphere > > > FullPhysics::Observable< RtAtmosphere >::olist

protectedinherited

Definition at line 200 of file observer.h.

ref_list

std::vector<boost::shared_ptr<Observer<RtAtmosphere > > > FullPhysics::Observable< RtAtmosphere >::ref_list

protectedinherited

Definition at line 201 of file observer.h.

timer

AccumulatedTimer RtAtmosphere::timer

staticinherited

Timer for RtAtmosphere.

Definition at line 55 of file rt_atmosphere.h.

---

The documentation for this class was generated from the following files:

• Implementation/atmosphere_oco.h
• Implementation/atmosphere_oco.cc