This gives the Gas Absorber Volumn mixing ratio for a single gas. More...

#include <absorber_vmr.h>

Inheritance diagram for FullPhysics::AbsorberVmr:

Collaboration diagram for FullPhysics::AbsorberVmr:

Public Member Functions
virtual	~AbsorberVmr ()

virtual void	add_observer (Observer< AbsorberVmr > &Obs)
	Add an observer. More...

void	add_observer_and_keep_reference (boost::shared_ptr< Observer< AbsorberVmr > > &Obs)
	Add an observer and keep a reference to it. More...

virtual boost::shared_ptr< AbsorberVmr >	clone () const =0
	Clone a AbsorberVmr object. More...

virtual boost::shared_ptr< AbsorberVmr >	clone (const boost::shared_ptr< Pressure > &Press) const =0
	This version of clone takes a pressure to use. More...

virtual std::string	gas_name () const =0
	This indicates the name of this particular Absorber. 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 void	print (std::ostream &Os) const

std::string	print_to_string () const
	Print to string. More...

virtual void	remove_observer (Observer< AbsorberVmr > &Obs)
	Remove an observer. More...

virtual blitz::Array< bool, 1 >	state_used () const =0
	Indicate what portion of the state vector is used to calculate the VMR. 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 ArrayAd< double, 1 >	vmr_grid (const Pressure &P) const
	Return the vmr on the pressure grid. More...

virtual AutoDerivative< double >	volume_mixing_ratio (const AutoDerivative< double > &P) const =0
	This returns the volume mixing ratio at the given pressure level. More...

Protected Member Functions
void	add_observer_do (Observer< AbsorberVmr > &Obs, AbsorberVmr &t)
	Add an observer. More...

void	add_observer_do (Observer< AbsorberVmr > &Obs)

void	clean_dead_ptr ()
	Remove any dead pointers. More...

void	notify_update_do (const AbsorberVmr &Self)
	Function to call to notify Observers of a state change. More...

void	remove_observer_do (Observer< AbsorberVmr > &Obs, AbsorberVmr &t)
	Remove an observer. More...

void	remove_observer_do (Observer< AbsorberVmr > &Obs)

Protected Attributes
std::list< boost::weak_ptr< Observer< AbsorberVmr > > >	olist

std::vector< boost::shared_ptr< Observer< AbsorberVmr > > >	ref_list

Detailed Description

This gives the Gas Absorber Volumn mixing ratio for a single gas.

This gets used by AbsorberAbsco class.

When implementing a new class, you almost always will want to derive from AbsorberVmrImpBase rather than from this class. See that class for a description.

Definition at line 17 of file absorber_vmr.h.

Constructor & Destructor Documentation

◆ ~AbsorberVmr()

virtual FullPhysics::AbsorberVmr::~AbsorberVmr ( )

inlinevirtual

Definition at line 20 of file absorber_vmr.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtual

Add an observer.

Implements FullPhysics::Observable< AbsorberVmr >.

Definition at line 21 of file absorber_vmr.h.

◆ add_observer_and_keep_reference()

void FullPhysics::Observable< AbsorberVmr >::add_observer_and_keep_reference ( boost::shared_ptr< Observer< AbsorberVmr > > & 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< AbsorberVmr >::add_observer_do	(	Observer< AbsorberVmr > &	Obs,
		AbsorberVmr &	t
	)

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone() [1/2]

virtual boost::shared_ptr<AbsorberVmr> FullPhysics::AbsorberVmr::clone ( ) const

pure virtual

Clone a AbsorberVmr object.

Note that the cloned version will not be attached to a StateVector or Observer<AbsorberVmr>, 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" AbsorberVmr object.

Implemented in FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrLevel, and FullPhysics::AbsorberVmrImpBase.

◆ clone() [2/2]

virtual boost::shared_ptr<AbsorberVmr> FullPhysics::AbsorberVmr::clone ( const boost::shared_ptr< Pressure > & Press ) const

pure virtual

This version of clone takes a pressure to use.

The intent is that the pressure has been cloned from the original pressure (although this class has no way to verify this). This allows sets of objects to be cloned using a common Pressure clone, e.g. Atmosphere.

Implemented in FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrMet, FullPhysics::AbsorberVmrImpBase, and FullPhysics::AbsorberVmrLevelScaled.

◆ gas_name()

virtual std::string FullPhysics::AbsorberVmr::gas_name ( ) const

pure virtual

This indicates the name of this particular Absorber.

The naming convention is free form but recommended to use the short form often used by HITRAN

Implemented in FullPhysics::AbsorberVmrImpBase.

◆ 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/2]

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

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.

◆ notify_add() [2/2]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/2]

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

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.

◆ notify_remove() [2/2]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update()

virtual void FullPhysics::Observer< StateVector >::notify_update ( const StateVector & Observed_object )

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.

◆ notify_update_do()

void FullPhysics::Observable< AbsorberVmr >::notify_update_do ( const AbsorberVmr & 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.

◆ print()

virtual void FullPhysics::StateVectorObserver::print ( std::ostream & Os ) const

inlinevirtualinherited

Definition at line 37 of file state_vector_observer.h.

◆ 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.

◆ remove_observer()

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

inlinevirtual

Remove an observer.

Implements FullPhysics::Observable< AbsorberVmr >.

Definition at line 23 of file absorber_vmr.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 181 of file observer.h.

◆ state_used()

virtual blitz::Array<bool, 1> FullPhysics::AbsorberVmr::state_used ( ) const

pure virtual

Indicate what portion of the state vector is used to calculate the VMR.

Implemented in FullPhysics::AbsorberVmrImpBase.

◆ 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.

◆ vmr_grid()

ArrayAd< double, 1 > AbsorberVmr::vmr_grid ( const Pressure & P ) const

virtual

Return the vmr on the pressure grid.

Definition at line 23 of file absorber_vmr.cc.

◆ volume_mixing_ratio()

virtual AutoDerivative<double> FullPhysics::AbsorberVmr::volume_mixing_ratio ( const AutoDerivative< double > & P ) const

pure virtual

This returns the volume mixing ratio at the given pressure level.

This is dimensionless, and the pressure is in Pascals

Implemented in FullPhysics::AbsorberVmrImpBase.

Member Data Documentation

◆ olist

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

protectedinherited

Definition at line 200 of file observer.h.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

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

Interface/absorber_vmr.h
Interface/absorber_vmr.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~AbsorberVmr()

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ clean_dead_ptr()

◆ clone() [1/2]

◆ clone() [2/2]

◆ gas_name()

◆ mark_used()

◆ notify_add() [1/2]

◆ notify_add() [2/2]

◆ notify_remove() [1/2]

◆ notify_remove() [2/2]

◆ notify_update()

◆ notify_update_do()

◆ print()

◆ print_to_string()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_used()

◆ state_vector_name()

◆ vmr_grid()

◆ volume_mixing_ratio()

Member Data Documentation

◆ olist

◆ ref_list