This class maintains the absorber portion of the state. More...

#include <absorber_absco.h>

Inheritance diagram for FullPhysics::AbsorberAbsco:

Collaboration diagram for FullPhysics::AbsorberAbsco:

Public Member Functions
	AbsorberAbsco (const std::vector< boost::shared_ptr< AbsorberVmr > > Vmr, const boost::shared_ptr< Pressure > &Press, const boost::shared_ptr< Temperature > &Temp, const std::vector< boost::shared_ptr< Altitude > > &Alt, const std::vector< boost::shared_ptr< GasAbsorption > > &Gas_absorption, const boost::shared_ptr< Constant > &C, int Nsub=10)
	Create an absorber. More...

virtual	~AbsorberAbsco ()

virtual boost::shared_ptr< AbsorberVmr >	absorber_vmr (const std::string &Gas_name) const
	Returns the AbsorberVmr object for a given species index. More...

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

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

AutoDerivative< double >	average_vmr (const std::string &Gas_name) const
	Returns the simple average volume mixing ratio for a gas. More...

virtual boost::shared_ptr< Absorber >	clone () const
	Clone an Absorber object. More...

virtual boost::shared_ptr< Absorber >	clone (const boost::shared_ptr< Pressure > &Press, const boost::shared_ptr< Temperature > &Temp, const std::vector< boost::shared_ptr< Altitude > > &Alt) const
	This version of clone takes a Pressure, Altitude and Temperature to use. More...

ArrayAdWithUnit< double, 1 >	dry_air_column_thickness_layer () const
	This is the dry air column thickness by layer. More...

ArrayAdWithUnit< double, 1 >	dry_air_molecular_density_layer () const
	This is a helper function to compute the common part of the dry air mass and wet air mass routines. More...

boost::shared_ptr< GasAbsorption >	gas_absorption_ptr (const std::string &Gas_name) const
	Return GasAbsorption as a pointer. More...

ArrayAdWithUnit< double, 1 >	gas_column_thickness_layer (const std::string &Gas_name) const
	This is the column thickness of a gas by layer. More...

virtual int	gas_index (const std::string &Name) const
	Map a gas name to the index number it appears in optical_depth_each_layer. More...

virtual std::string	gas_name (int Species_index) const
	Name of gases, in the order that optical_depth_each_layer returns them. More...

AutoDerivativeWithUnit< double >	gas_total_column_thickness (const std::string &Gas_name) const
	This is the total column thickness of a gas. More...

ArrayAdWithUnit< double, 1 >	gravity_sublayer (int Spec_index) const
	Return the gravity we use for each sublayer. More...

ArrayAdWithUnit< double, 1 >	h2o_vmr_sublayer () const
	Return the H2O volume mixing ratio we use for each sublayer. More...

double	integrand (double wn, double p, int Spec_index, int Species_index) const
	Integrand used in the absorption calculation. More...

AutoDerivativeWithUnit< double >	integrand_independent_wn (int Spec_index, int Species_index, const DoubleWithUnit &P) const
	This is the portion of the optical depth calculation integrand that is independent on the wave number. 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 (AbsorberVmr &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 (Temperature &Observed_object)
	Called when an object is added to an Observable. More...

virtual void	notify_add (Altitude &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 ()

virtual void	notify_add ()

virtual void	notify_remove (Altitude &Observed_object)
	Called when an object is removed from an Observable. More...

virtual void	notify_remove (StateVector &Observed_object)
	Called when an object is removed from an Observable. More...

virtual void	notify_remove (AbsorberVmr &Observed_object)
	Called when an object is removed from an Observable. More...

virtual void	notify_remove (Temperature &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 ()

virtual void	notify_remove ()

virtual void	notify_update (const StateVector &Sv)
	Called when the Observed object is updated. More...

virtual void	notify_update (const Pressure &P)
	For performance, we cache some data as we calculate it. More...

virtual void	notify_update (const Temperature &T)
	Called when the Observed object is updated. More...

virtual void	notify_update (const Altitude &A)
	Called when the Observed object is updated. More...

virtual void	notify_update (const AbsorberVmr &A)
	Called when the Observed object is updated. More...

virtual int	number_layer () const

virtual int	number_species () const
	Number of species. More...

virtual int	number_spectrometer () const

virtual ArrayAd< double, 2 >	optical_depth_each_layer (double wn, int spec_index) const
	This gives the optical depth for each layer, for the given wave number. More...

double	optical_depth_each_layer_direct_integrate (double wn, int Spec_index, int Species_index, int Layer_index, double eps_abs=0, double eps_rel=1e-3) const
	Find the optical depth for a layer by directly integrating the integrand function. More...

blitz::Array< double, 2 >	optical_depth_each_layer_direct_integrate (double wn, int Spec_index, double eps_abs=0, double eps_rel=1e-3) const
	Version of optical_depth_each_layer_direct_integrate that returns an array of species/layer like optical_depth_each_layer does. More...

virtual blitz::Array< double, 2 >	optical_depth_each_layer_nder (double wn, int spec_index) const

const Pressure &	pressure () const

ArrayWithUnit< double, 1 >	pressure_sublayer () const
	Return the pressure we use for each sublayer. More...

ArrayAd< double, 1 >	pressure_weighting_function_grid () const
	This is the pressure weighting function by grid level. More...

ArrayAd< double, 1 >	pressure_weighting_function_layer () const
	This is the pressure weighting function by layer. More...

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

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

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

ArrayAdWithUnit< double, 1 >	specific_humidity_layer () const
	Returns specific humidity by layer. 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...

ArrayAdWithUnit< double, 1 >	temperature_sublayer () const
	Return the temperature we use for each sublayer. More...

AutoDerivative< double >	total_number_density (const std::string &Gas_name) const

ArrayAdWithUnit< double, 1 >	vmr_sublayer (const std::string &Gas_name) const
	Return the volume mixing ratio we use for each sublayer. More...

ArrayAdWithUnit< double, 1 >	wet_air_column_thickness_layer () const
	This is the wet air column thickness by layer. More...

virtual AutoDerivative< double >	xgas (const std::string &Gas_name) const
	This calculates the gas column, e.g., XCO2. More...

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

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

void	add_observer_do (Observer< Absorber > &Obs)

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

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

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

void	remove_observer_do (Observer< Absorber > &Obs)

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

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

Detailed Description

This class maintains the absorber portion of the state.

This particular implementation uses the GasAbsorption classes for calculating the gas absorption (e.g, the Absco tables).

Definition at line 23 of file absorber_absco.h.

Constructor & Destructor Documentation

◆ AbsorberAbsco()

AbsorberAbsco::AbsorberAbsco	(	const std::vector< boost::shared_ptr< AbsorberVmr > >	Vmr,
		const boost::shared_ptr< Pressure > &	Press,
		const boost::shared_ptr< Temperature > &	Temp,
		const std::vector< boost::shared_ptr< Altitude > > &	Alt,
		const std::vector< boost::shared_ptr< GasAbsorption > > &	Gas_absorption,
		const boost::shared_ptr< Constant > &	C,
		int	Nsub = `10`
	)

Create an absorber.

Definition at line 564 of file absorber_absco.cc.

◆ ~AbsorberAbsco()

virtual FullPhysics::AbsorberAbsco::~AbsorberAbsco ( )

inlinevirtual

Definition at line 37 of file absorber_absco.h.

Member Function Documentation

◆ absorber_vmr()

boost::shared_ptr< AbsorberVmr > AbsorberAbsco::absorber_vmr ( const std::string & gas_name ) const

virtual

Returns the AbsorberVmr object for a given species index.

Implements FullPhysics::Absorber.

Definition at line 880 of file absorber_absco.cc.

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< Absorber >.

Definition at line 32 of file absorber.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ average_vmr()

AutoDerivative< double > AbsorberAbsco::average_vmr ( const std::string & Gas_name ) const

Returns the simple average volume mixing ratio for a gas.

The units returned are mole / mole, same as for vmr.

Definition at line 818 of file absorber_absco.cc.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone() [1/2]

boost::shared_ptr< Absorber > AbsorberAbsco::clone ( ) const

virtual

Clone an Absorber object.

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

Implements FullPhysics::Absorber.

Definition at line 611 of file absorber_absco.cc.

◆ clone() [2/2]

boost::shared_ptr< Absorber > AbsorberAbsco::clone	(	const boost::shared_ptr< Pressure > &	Press,
		const boost::shared_ptr< Temperature > &	Temp,
		const std::vector< boost::shared_ptr< Altitude > > &	Alt
	)		const

virtual

This version of clone takes a Pressure, Altitude and Temperature to use.

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

Implements FullPhysics::Absorber.

Definition at line 624 of file absorber_absco.cc.

◆ dry_air_column_thickness_layer()

ArrayAdWithUnit< double, 1 > AbsorberAbsco::dry_air_column_thickness_layer ( ) const

This is the dry air column thickness by layer.

This is the size of pressure_grid() - 1.

Definition at line 696 of file absorber_absco.cc.

◆ dry_air_molecular_density_layer()

ArrayAdWithUnit< double, 1 > AbsorberAbsco::dry_air_molecular_density_layer ( ) const

This is a helper function to compute the common part of the dry air mass and wet air mass routines.

It returns dry air molecular density (per square meter) in the case where there is no water vapor. Returns units of molecules m^-2

Definition at line 669 of file absorber_absco.cc.

◆ gas_absorption_ptr()

boost::shared_ptr< GasAbsorption > AbsorberAbsco::gas_absorption_ptr ( const std::string & Gas_name ) const

Return GasAbsorption as a pointer.

Definition at line 896 of file absorber_absco.cc.

◆ gas_column_thickness_layer()

ArrayAdWithUnit< double, 1 > AbsorberAbsco::gas_column_thickness_layer ( const std::string & Gas_name ) const

This is the column thickness of a gas by layer.

This is the size of pressure_grid() - 1.

Definition at line 770 of file absorber_absco.cc.

◆ gas_index()

int Absorber::gas_index ( const std::string & Name ) const

virtualinherited

Map a gas name to the index number it appears in optical_depth_each_layer.

This return -1 if the Name is not one of the gases.

Definition at line 28 of file absorber.cc.

◆ gas_name()

virtual std::string FullPhysics::AbsorberAbsco::gas_name ( int Species_index ) const

inlinevirtual

Name of gases, in the order that optical_depth_each_layer returns them.

Implements FullPhysics::Absorber.

Definition at line 47 of file absorber_absco.h.

◆ gas_total_column_thickness()

AutoDerivativeWithUnit< double > AbsorberAbsco::gas_total_column_thickness ( const std::string & Gas_name ) const

This is the total column thickness of a gas.

Definition at line 793 of file absorber_absco.cc.

◆ gravity_sublayer()

ArrayAdWithUnit< double, 1 > AbsorberAbsco::gravity_sublayer ( int Spec_index ) const

Return the gravity we use for each sublayer.

This is meant for diagnostic purposes.

Definition at line 847 of file absorber_absco.cc.

◆ h2o_vmr_sublayer()

ArrayAdWithUnit< double, 1 > AbsorberAbsco::h2o_vmr_sublayer ( ) const

Return the H2O volume mixing ratio we use for each sublayer.

This is meant for diagnostic purposes.

Definition at line 927 of file absorber_absco.cc.

◆ integrand()

double AbsorberAbsco::integrand	(	double	wn,
		double	P,
		int	Spec_index,
		int	Species_index
	)		const

Integrand used in the absorption calculation.

This is in Pa^-1. wn should be in cm^-1, and P in Pascals.

Definition at line 56 of file absorber_absco.cc.

◆ integrand_independent_wn()

AutoDerivativeWithUnit< double > AbsorberAbsco::integrand_independent_wn	(	int	Spec_index,
		int	Species_index,
		const DoubleWithUnit &	P
	)		const

This is the portion of the optical depth calculation integrand that is independent on the wave number.

We separate this out because we can calculate this portion once and cache it. This only changes if the Pressure, Temperature, Altitude, or VMR has changed (e.g., the state vector is updated).

Definition at line 41 of file absorber_absco.cc.

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

virtual void FullPhysics::Observer< Altitude >::notify_add ( Altitude & 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/10]

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() [3/10]

virtual void FullPhysics::Observer< AbsorberVmr >::notify_add ( AbsorberVmr & 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() [4/10]

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() [5/10]

virtual void FullPhysics::Observer< Temperature >::notify_add ( Temperature & 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.