As a design principle, we have each base class with the absolutely minimum interface needed for use from the rest of the system. More...

#include <aerosol_extinction_imp_base.h>

Inheritance diagram for FullPhysics::AerosolExtinctionImpBase:

Collaboration diagram for FullPhysics::AerosolExtinctionImpBase:

Public Member Functions
virtual	~AerosolExtinctionImpBase ()

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

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

virtual ArrayAd< double, 1 >	aerosol_extinction () const

virtual std::string	aerosol_name () const
	Name of aerosol. More...

blitz::Array< double, 1 >	aerosol_parameter () const
	Returns the value of the coefficients used to generate the aerosol extinction. More...

blitz::Array< double, 1 >	aerosol_parameter_uncertainty () const
	Returns the uncertainty of the aerosol type coefficients. More...

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

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

const ArrayAd< double, 1 > &	coefficient () const

virtual std::string	desc () const
	Description of object, to be printed to stream. More...

virtual AutoDerivative< double >	extinction_for_layer (int i) const
	Extinction for given layer. 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...

virtual std::string	model_short_name () const =0
	A short name representing the type of extinction model being implemented. 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...

const boost::shared_ptr< Pressure > &	pressure () const

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< AerosolExtinction > &Obs)
	Remove an observer. 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...

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

Protected Member Functions
	AerosolExtinctionImpBase ()
	Default constructor, derived class should call init if they use this constructor. More...

	AerosolExtinctionImpBase (const std::string &Aerosol_name, const blitz::Array< double, 1 > &Coeff, const blitz::Array< bool, 1 > &Used_flag, const boost::shared_ptr< Pressure > &Press, bool Mark_according_to_press=true, int Pdep_start=0)
	Constructor that sets the coefficient() and used_flag() values. More...

void	add_observer_do (Observer< AerosolExtinction > &Obs, AerosolExtinction &t)
	Add an observer. More...

void	add_observer_do (Observer< AerosolExtinction > &Obs)

virtual void	calc_aerosol_extinction () const =0
	Derived classes should provide a function to fill in vmr when this is called. More...

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

void	init (const std::string Aerosol_name, const blitz::Array< double, 1 > &Coeff, const blitz::Array< bool, 1 > &Used_flag, const boost::shared_ptr< Pressure > &Press, bool Mark_according_to_press=true, int Pdep_start=0)
	Initialize object. More...

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

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

void	remove_observer_do (Observer< AerosolExtinction > &Obs)

void	state_vector_observer_initialize (int Plen)
	Take the given number of state vector parameters. More...

virtual AutoDerivative< double >	total_aod () const
	Total aerosol optical depth of the extinction values in aext. More...

Protected Attributes
ArrayAd< double, 1 >	aext
	The cached aerosol extinction for each level. More...

bool	cache_stale
	If this is true, the recalculate the vmr 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< AerosolExtinction > > >	olist

int	pdep_start
	Index of first coefficient that depends on the number of pressure levels. More...

boost::shared_ptr< Pressure >	press
	Pressure. More...

std::vector< boost::shared_ptr< Observer< AerosolExtinction > > >	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...

Detailed Description

As a design principle, we have each base class with the absolutely minimum interface needed for use from the rest of the system.

This allows us to support any future code that supports this minimum interface.

However, almost always you will want to derive from this class instead. See PressureImpBase for a more complete discussion of this.

Definition at line 16 of file aerosol_extinction_imp_base.h.

Constructor & Destructor Documentation

◆ ~AerosolExtinctionImpBase()

virtual FullPhysics::AerosolExtinctionImpBase::~AerosolExtinctionImpBase ( )

inlinevirtual

Definition at line 18 of file aerosol_extinction_imp_base.h.

◆ AerosolExtinctionImpBase() [1/2]

FullPhysics::AerosolExtinctionImpBase::AerosolExtinctionImpBase ( )

inlineprotected

Default constructor, derived class should call init if they use this constructor.

Definition at line 127 of file aerosol_extinction_imp_base.h.

◆ AerosolExtinctionImpBase() [2/2]

FullPhysics::AerosolExtinctionImpBase::AerosolExtinctionImpBase	(	const std::string &	Aerosol_name,
		const blitz::Array< double, 1 > &	Coeff,
		const blitz::Array< bool, 1 > &	Used_flag,
		const boost::shared_ptr< Pressure > &	Press,
		bool	Mark_according_to_press = `true`,
		int	Pdep_start = `0`
	)

inlineprotected

Constructor that sets the coefficient() and used_flag() values.

See SubStateVectorArray for a discussion of Mark_according_to_press and Pdep_start.

Definition at line 134 of file aerosol_extinction_imp_base.h.

Member Function Documentation

◆ add_observer()

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

inlinevirtualinherited

Add an observer.

Implements FullPhysics::Observable< AerosolExtinction >.

Definition at line 25 of file aerosol_extinction.h.

◆ add_observer_and_keep_reference()

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

inlineprotectedinherited

Add an observer.

Definition at line 148 of file observer.h.

◆ add_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 159 of file observer.h.

◆ aerosol_extinction()

virtual ArrayAd<double, 1> FullPhysics::AerosolExtinctionImpBase::aerosol_extinction ( ) const

inlinevirtual

Definition at line 20 of file aerosol_extinction_imp_base.h.

◆ aerosol_name()

virtual std::string FullPhysics::AerosolExtinctionImpBase::aerosol_name ( ) const

inlinevirtual

Name of aerosol.

Implements FullPhysics::AerosolExtinction.

Definition at line 19 of file aerosol_extinction_imp_base.h.

◆ aerosol_parameter()

blitz::Array<double, 1> FullPhysics::AerosolExtinctionImpBase::aerosol_parameter ( ) const

inline

Returns the value of the coefficients used to generate the aerosol extinction.

Definition at line 56 of file aerosol_extinction_imp_base.h.

◆ aerosol_parameter_uncertainty()

blitz::Array<double, 1> FullPhysics::AerosolExtinctionImpBase::aerosol_parameter_uncertainty ( ) const

inline

Returns the uncertainty of the aerosol type coefficients.

Definition at line 65 of file aerosol_extinction_imp_base.h.

◆ calc_aerosol_extinction()

virtual void FullPhysics::AerosolExtinctionImpBase::calc_aerosol_extinction ( ) const

protectedpure virtual

Derived classes should provide a function to fill in vmr when this is called.

Implemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

◆ clean_dead_ptr()

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

inlineprotectedinherited

Remove any dead pointers.

Definition at line 196 of file observer.h.

◆ clone() [1/2]

virtual boost::shared_ptr<AerosolExtinction> FullPhysics::AerosolExtinctionImpBase::clone ( ) const

pure virtual

Clone a AerosolExtinction object.

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

Implements FullPhysics::AerosolExtinction.

Implemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

◆ clone() [2/2]

virtual boost::shared_ptr<AerosolExtinction> FullPhysics::AerosolExtinctionImpBase::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.

Implements FullPhysics::AerosolExtinction.

Implemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

◆ coefficient()

const ArrayAd<double, 1>& FullPhysics::SubStateVectorArray< AerosolExtinction >::coefficient ( ) const

inlineinherited

Definition at line 171 of file sub_state_vector_array.h.

◆ desc()

virtual std::string FullPhysics::AerosolExtinctionImpBase::desc ( ) const

inlinevirtual

Description of object, to be printed to stream.

This gives a cleaner interface for deriving from python.

Definition at line 49 of file aerosol_extinction_imp_base.h.

◆ extinction_for_layer()

virtual AutoDerivative<double> FullPhysics::AerosolExtinctionImpBase::extinction_for_layer ( int i ) const

inlinevirtual

Extinction for given layer.

Implements FullPhysics::AerosolExtinction.

Definition at line 22 of file aerosol_extinction_imp_base.h.

◆ init() [1/2]

void FullPhysics::SubStateVectorArray< AerosolExtinction >::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`
	)

inlineinherited

Definition at line 59 of file sub_state_vector_array.h.

◆ init() [2/2]

void FullPhysics::AerosolExtinctionImpBase::init	(	const std::string	Aerosol_name,
		const blitz::Array< double, 1 > &	Coeff,
		const blitz::Array< bool, 1 > &	Used_flag,
		const boost::shared_ptr< Pressure > &	Press,
		bool	Mark_according_to_press = `true`,
		int	Pdep_start = `0`
	)

inlineprotected

Initialize object.

Definition at line 110 of file aerosol_extinction_imp_base.h.

◆ mark_used() [1/2]

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

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.

◆ mark_used() [2/2]

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.

◆ mark_used_sub()

void FullPhysics::SubStateVectorArray< AerosolExtinction >::mark_used_sub ( blitz::Array< bool, 1 > & Used ) const

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.

◆ model_short_name()

virtual std::string FullPhysics::AerosolExtinctionImpBase::model_short_name ( ) const

pure virtual

A short name representing the type of extinction model being implemented.

Implemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

◆ notify_add() [1/3]

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/3]

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

inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_add() [3/3]

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

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.

◆ notify_remove() [1/3]

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/3]

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

inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_remove() [3/3]

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

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.

◆ notify_update() [1/2]

void SubStateVectorObserver::notify_update ( const StateVector & Observed_object )

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.

◆ notify_update() [2/2]

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< AerosolExtinction >::notify_update_do ( const AerosolExtinction & 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.

◆ pressure()

const boost::shared_ptr<Pressure>& FullPhysics::SubStateVectorArray< AerosolExtinction >::pressure ( ) const

inlineinherited

Definition at line 186 of file sub_state_vector_array.h.

◆ print()

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

inlinevirtual

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::SubStateVectorObserver.

Reimplemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

Definition at line 43 of file aerosol_extinction_imp_base.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::AerosolExtinction::remove_observer ( Observer< AerosolExtinction > & Obs )

inlinevirtualinherited

Remove an observer.

Implements FullPhysics::Observable< AerosolExtinction >.

Definition at line 27 of file aerosol_extinction.h.

◆ remove_observer_do() [1/2]

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

inlineprotectedinherited

Remove an observer.

Definition at line 173 of file observer.h.

◆ remove_observer_do() [2/2]

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

inlineprotectedinherited

Definition at line 181 of file observer.h.

◆ state_vector_name() [1/2]

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

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.

◆ state_vector_name() [2/2]

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.

◆ state_vector_name_i()

virtual std::string FullPhysics::SubStateVectorArray< AerosolExtinction >::state_vector_name_i ( int i ) const

inlinevirtualinherited

Return state vector name for ith entry in coeff.

Reimplemented in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

Definition at line 129 of file sub_state_vector_array.h.

◆ state_vector_name_sub()

virtual void FullPhysics::SubStateVectorArray< AerosolExtinction >::state_vector_name_sub ( blitz::Array< std::string, 1 > & Sv_name ) const

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.

◆ state_vector_observer_initialize()

void SubStateVectorObserver::state_vector_observer_initialize ( int Plen )

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.

◆ state_vector_start_index()

int FullPhysics::SubStateVectorObserver::state_vector_start_index ( ) const

inlineinherited

Starting index of state vector used by this object.

Definition at line 25 of file sub_state_vector_observer.h.

◆ statevector_covariance()

const blitz::Array<double, 2>& FullPhysics::SubStateVectorArray< AerosolExtinction >::statevector_covariance ( ) const

inlineinherited

Definition at line 181 of file sub_state_vector_array.h.

◆ sub_state_identifier()

virtual std::string FullPhysics::SubStateVectorArray< AerosolExtinction >::sub_state_identifier ( ) const

inlinevirtualinherited

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 in FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolExtinctionLog, and FullPhysics::AerosolExtinctionLinear.

Definition at line 120 of file sub_state_vector_array.h.

◆ sub_vector_size()

int FullPhysics::SubStateVectorObserver::sub_vector_size ( ) const

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.

◆ total_aod()

virtual AutoDerivative<double> FullPhysics::AerosolExtinctionImpBase::total_aod ( ) const

inlineprotectedvirtual

Total aerosol optical depth of the extinction values in aext.

Definition at line 95 of file aerosol_extinction_imp_base.h.

◆ update_sub_state()

virtual void FullPhysics::SubStateVectorArray< AerosolExtinction >::update_sub_state	(	const ArrayAd< double, 1 > &	Sv_sub,
		const blitz::Array< double, 2 > &	Cov
	)

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.

◆ update_sub_state_hook()

virtual void FullPhysics::AerosolExtinctionImpBase::update_sub_state_hook ( )

inlinevirtual

Hook for anything a derived class needs to do after coefficient is updated and before notify_update.

Default is nothing.

Reimplemented from FullPhysics::SubStateVectorArray< AerosolExtinction >.

Definition at line 28 of file aerosol_extinction_imp_base.h.

◆ used_flag_value()

const blitz::Array<bool, 1>& FullPhysics::SubStateVectorArray< AerosolExtinction >::used_flag_value ( ) const

inlineinherited

Definition at line 176 of file sub_state_vector_array.h.

Member Data Documentation

◆ aext

ArrayAd<double, 1> FullPhysics::AerosolExtinctionImpBase::aext

mutableprotected

The cached aerosol extinction for each level.

This should be filled in by derived classes when calc_aerosol_extinction() is called.

Definition at line 84 of file aerosol_extinction_imp_base.h.

◆ cache_stale

bool FullPhysics::AerosolExtinctionImpBase::cache_stale

mutableprotected

If this is true, the recalculate the vmr the next time we need it.

Definition at line 78 of file aerosol_extinction_imp_base.h.

◆ coeff

ArrayAd<double, 1> FullPhysics::SubStateVectorArray< AerosolExtinction >::coeff

protectedinherited

Coefficients.

Definition at line 196 of file sub_state_vector_array.h.

◆ cov

blitz::Array<double, 2> FullPhysics::SubStateVectorArray< AerosolExtinction >::cov

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.

◆ mark_according_to_press

bool FullPhysics::SubStateVectorArray< AerosolExtinction >::mark_according_to_press

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.

◆ olist

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

protectedinherited

Definition at line 200 of file observer.h.

◆ pdep_start

int FullPhysics::SubStateVectorArray< AerosolExtinction >::pdep_start

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.

◆ press

boost::shared_ptr<Pressure> FullPhysics::SubStateVectorArray< AerosolExtinction >::press

protectedinherited

Pressure.

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.

◆ ref_list

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

protectedinherited

Definition at line 201 of file observer.h.

◆ sv_cov_full

blitz::Array<double, 2> FullPhysics::SubStateVectorObserver::sv_cov_full

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.

◆ sv_cov_sub

blitz::Array<double, 2> FullPhysics::SubStateVectorObserver::sv_cov_sub

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.

◆ sv_full

ArrayAd<double, 1> FullPhysics::SubStateVectorObserver::sv_full

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.

◆ sv_sub

ArrayAd<double, 1> FullPhysics::SubStateVectorObserver::sv_sub

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.

◆ used_flag

blitz::Array<bool, 1> FullPhysics::SubStateVectorArray< AerosolExtinction >::used_flag

protectedinherited

Flag indicating which of the coefficients gets updated by the StateVector.

Definition at line 210 of file sub_state_vector_array.h.

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

Interface/aerosol_extinction_imp_base.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~AerosolExtinctionImpBase()

◆ AerosolExtinctionImpBase() [1/2]

◆ AerosolExtinctionImpBase() [2/2]

Member Function Documentation

◆ add_observer()

◆ add_observer_and_keep_reference()

◆ add_observer_do() [1/2]

◆ add_observer_do() [2/2]

◆ aerosol_extinction()

◆ aerosol_name()

◆ aerosol_parameter()

◆ aerosol_parameter_uncertainty()

◆ calc_aerosol_extinction()

◆ clean_dead_ptr()

◆ clone() [1/2]

◆ clone() [2/2]

◆ coefficient()

◆ desc()

◆ extinction_for_layer()

◆ init() [1/2]

◆ init() [2/2]

◆ mark_used() [1/2]

◆ mark_used() [2/2]

◆ mark_used_sub()

◆ model_short_name()

◆ notify_add() [1/3]

◆ notify_add() [2/3]

◆ notify_add() [3/3]

◆ notify_remove() [1/3]

◆ notify_remove() [2/3]

◆ notify_remove() [3/3]

◆ notify_update() [1/2]

◆ notify_update() [2/2]

◆ notify_update_do()

◆ pressure()

◆ print()

◆ print_to_string()

◆ remove_observer()

◆ remove_observer_do() [1/2]

◆ remove_observer_do() [2/2]

◆ state_vector_name() [1/2]

◆ state_vector_name() [2/2]

◆ state_vector_name_i()

◆ state_vector_name_sub()

◆ state_vector_observer_initialize()

◆ state_vector_start_index()

◆ statevector_covariance()

◆ sub_state_identifier()

◆ sub_vector_size()

◆ total_aod()

◆ update_sub_state()

◆ update_sub_state_hook()

◆ used_flag_value()

Member Data Documentation

◆ aext

◆ cache_stale

◆ coeff

◆ cov

◆ mark_according_to_press

◆ olist

◆ pdep_start

◆ press

◆ ref_list

◆ sv_cov_full

◆ sv_cov_sub

◆ sv_full

◆ sv_sub

◆ used_flag