This class is used to create the Aerosol from a Merra climatology file. More...

#include <merra_aerosol.h>

Inheritance diagram for FullPhysics::MerraAerosol:

Collaboration diagram for FullPhysics::MerraAerosol:

Public Member Functions
	MerraAerosol (const HdfFile &Merra_climatology, const HdfFile &Aerosol_property, DoubleWithUnit Latitude, DoubleWithUnit Longitude, const boost::shared_ptr< Pressure > &Press, const boost::shared_ptr< RelativeHumidity > &Rh, const blitz::Array< double, 2 > &Aerosol_cov, double Max_aod=0.2, double Exp_aod=0.8, int Min_types=2, int Max_types=4, bool Linear_aod=false, bool Relative_humidity_aerosol=false, double Max_residual=0.005, double Reference_wn=1e4/0.755)
	Constructor. More...

virtual	~MerraAerosol ()

void	add_aerosol (const boost::shared_ptr< AerosolExtinction > &Aext, const boost::shared_ptr< AerosolProperty > &Aprop, const boost::shared_ptr< InitialGuessBuilder > &Ig)
	Add in an aerosol that comes from some source other than Dijian's files (e.g., hardcoded aerosols to include at all times) More...

boost::shared_ptr< Aerosol >	aerosol () const
	Return the aerosol setup generated from this class. More...

boost::shared_ptr< InitialGuessBuilder >	initial_guess () const
	Return IntitialGuessBuilder for the Aerosol. More...

int	number_merra_particle () const
	Number of merra particles. More...

virtual void	print (std::ostream &Os) const
	Print to stream. More...

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

Detailed Description

This class is used to create the Aerosol from a Merra climatology file.

Definition at line 15 of file merra_aerosol.h.

Constructor & Destructor Documentation

◆ MerraAerosol()

MerraAerosol::MerraAerosol	(	const HdfFile &	Merra_climatology,
		const HdfFile &	Aerosol_property,
		DoubleWithUnit	Latitude,
		DoubleWithUnit	Longitude,
		const boost::shared_ptr< Pressure > &	Press,
		const boost::shared_ptr< RelativeHumidity > &	Rh,
		const blitz::Array< double, 2 > &	Aerosol_cov,
		double	Max_aod = `0.2`,
		double	Exp_aod = `0.8`,
		int	Min_types = `2`,
		int	Max_types = `4`,
		bool	Linear_aod = `false`,
		bool	Relative_humidity_aerosol = `false`,
		double	Max_residual = `0.005`,
		double	Reference_wn = `1e4/0.755`
	)

Constructor.

Parameters

Merra_climatology	The Merra climatology file
Aerosol_property	The Aerosol property file
Latitude	The latitude of the ground point
Longitude	The longitude of the ground point
Press	The Pressure object that gives the pressure grid.
Rh	The RelativeHumidity object that gives the relative humidity.
Aerosol_cov	The covariance matrix to use for each Aerosol.
Max_aod	Maximum AOD cap for each composite type
Exp_aod	Threshold for explained fraction of AOD
Min_types	Minimum number of types to be selected
Max_types	Maximum number of types to be selected
Linear_aod	If true, then use linear aod rather than logarithmic aod.
Relative_humidity_aerosol	If true, then use AerosolPropertyRhHdf instead of AerosolPropertyHdf which includes interpolation by relative humidity.
Max_residual	Maximum resdidual in total AOD (either > threshold of fraction or < max residual will suffice
Reference_wn	The wavenumber that Aext is given for. This is optional, the default value matches the reference band given in the ATB.

Definition at line 71 of file merra_aerosol.cc.

◆ ~MerraAerosol()

virtual FullPhysics::MerraAerosol::~MerraAerosol ( )

inlinevirtual

Definition at line 31 of file merra_aerosol.h.

Member Function Documentation

◆ add_aerosol()

void MerraAerosol::add_aerosol	(	const boost::shared_ptr< AerosolExtinction > &	Aext,
		const boost::shared_ptr< AerosolProperty > &	Aprop,
		const boost::shared_ptr< InitialGuessBuilder > &	Ig
	)

Add in an aerosol that comes from some source other than Dijian's files (e.g., hardcoded aerosols to include at all times)

Definition at line 184 of file merra_aerosol.cc.

◆ aerosol()

boost::shared_ptr< Aerosol > MerraAerosol::aerosol ( ) const

Return the aerosol setup generated from this class.

Definition at line 171 of file merra_aerosol.cc.

◆ initial_guess()

boost::shared_ptr<InitialGuessBuilder> FullPhysics::MerraAerosol::initial_guess ( ) const

inline

Return IntitialGuessBuilder for the Aerosol.

Definition at line 41 of file merra_aerosol.h.

◆ number_merra_particle()

int FullPhysics::MerraAerosol::number_merra_particle ( ) const

inline

Number of merra particles.

Definition at line 47 of file merra_aerosol.h.

◆ print()

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

virtual

Print to stream.

Definition at line 245 of file merra_aerosol.cc.

◆ print_to_string()

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

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

Implementation/merra_aerosol.h
Implementation/merra_aerosol.cc

Public Member Functions