FullPhysics::AerosolAodOutput Class Reference

This registers the portions of the Aerosol class that should be written as output. More...

#include <aerosol_aod_output.h>

Inheritance diagram for FullPhysics::AerosolAodOutput:

Collaboration diagram for FullPhysics::AerosolAodOutput:

Public Member Functions
	AerosolAodOutput (const boost::shared_ptr< Aerosol > &A, bool Number_instead_of_name=false)
	Constructor. More...
virtual	~AerosolAodOutput ()
virtual std::string	desc () const
	Description of object, to be printed to stream. More...
virtual void	print (std::ostream &Os) const
	Print to stream. More...
std::string	print_to_string () const
	Print to string. More...
virtual void	register_output (const boost::shared_ptr< Output > &out) const
	Register portions of class that will be written to output. More...
virtual void	register_output_apriori (const boost::shared_ptr< Output > &out) const
	Register apriori portions of class. More...

Static Public Attributes
static const double	high_boundary = 500e2
	The boundary for calculating retrieved_aerosol_aod_by_type_high. More...
static const double	low_boundary = 800e2
	The boundary for calculating retrieved_aerosol_aod_by_type_low. More...

Detailed Description

This registers the portions of the Aerosol class that should be written as output.

See the discussion in RegisterOutputBase why this isn't just part of the Aerosol class.

Definition at line 14 of file aerosol_aod_output.h.

Constructor & Destructor Documentation

AerosolAodOutput()

AerosolAodOutput::AerosolAodOutput	(	const boost::shared_ptr< Aerosol > &	A,
		bool	Number_instead_of_name = false
	)

Constructor.

We either name the output fields by the aerosol name (e.g., aerosol_ice_aod), or we name it by the index number (e.g., aerosol_1_aod). This is controlled by the Number_instead_of_name field.

Definition at line 21 of file aerosol_aod_output.cc.

~AerosolAodOutput()

virtual FullPhysics::AerosolAodOutput::~AerosolAodOutput ( )

inlinevirtual

Definition at line 24 of file aerosol_aod_output.h.

Member Function Documentation

desc()

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

inlinevirtualinherited

Description of object, to be printed to stream.

This gives a cleaner interface for deriving from python.

Reimplemented in FullPhysics::HighResSpectrumOutput.

Definition at line 83 of file register_output_base.h.

print()

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

inlinevirtualinherited

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.

Definition at line 76 of file register_output_base.h.

print_to_string()

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

register_output()

void AerosolAodOutput::register_output ( const boost::shared_ptr< Output > &  out ) const

virtual

Register portions of class that will be written to output.

This is for the final statevector, for classes where apriori and final are written out different.

Implements FullPhysics::RegisterOutputBase.

Definition at line 37 of file aerosol_aod_output.cc.

register_output_apriori()

virtual void FullPhysics::RegisterOutputBase::register_output_apriori ( const boost::shared_ptr< Output > &  out ) const

inlinevirtualinherited

Register apriori portions of class.

The default is not to have anything written out, but derived classes can override this.

Note that by convention that we "freeze" the state of the class when we register the apriori_output. This allows for things like the StateVector to be changed after wards without changing the apriori state.

Reimplemented in FullPhysics::AerosolConsolidatedOutput, FullPhysics::HighResSpectrumOutput, FullPhysics::StateVectorOutput, FullPhysics::AltitudeOutput, FullPhysics::EmpiricalOrthogonalFunctionOutput, FullPhysics::AbsorberVmrFixedLevelOutput, FullPhysics::PressureFixedLevelOutput, FullPhysics::AbsorberAbscoOutput, FullPhysics::DispersionPolynomialOutput, FullPhysics::GroundBrdfOutput, FullPhysics::GroundCoxmunkPlusLambertianOutput, FullPhysics::PressureOutput, FullPhysics::AbsorberVmrFixedLevelScaledOutput, FullPhysics::AbsorberVmrLevelOutput, FullPhysics::AbsorberVmrLevelScaledOutput, FullPhysics::AbsorberVmrMetOutput, FullPhysics::TemperatureFixedLevelOutput, FullPhysics::AerosolParamOutput, FullPhysics::DispersionFitOutput, FullPhysics::GroundCoxmunkOutput, FullPhysics::GroundLambertianOutput, FullPhysics::StokesCoefficientFractionOutput, FullPhysics::TemperatureLevelOffsetOutput, FullPhysics::TemperatureMetOutput, FullPhysics::RadianceScalingOutput, FullPhysics::GasVmrAprioriOutput, and FullPhysics::FluorescenceEffectOutput.

Definition at line 67 of file register_output_base.h.

Member Data Documentation

high_boundary

const double AerosolAodOutput::high_boundary = 500e2

static

The boundary for calculating retrieved_aerosol_aod_by_type_high.

Definition at line 27 of file aerosol_aod_output.h.

low_boundary

const double AerosolAodOutput::low_boundary = 800e2

static

The boundary for calculating retrieved_aerosol_aod_by_type_low.

Definition at line 26 of file aerosol_aod_output.h.

---

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

• RegisterOutput/aerosol_aod_output.h
• RegisterOutput/aerosol_aod_output.cc