This is a test fixture that creates an Atmosphere and related Statevector based on the unit test data set up in ConfigurationFixture. More...

#include <atmosphere_fixture.h>

Inheritance diagram for FullPhysics::AtmosphereFixture:

Collaboration diagram for FullPhysics::AtmosphereFixture:

Public Member Functions
	AtmosphereFixture ()

virtual	~AtmosphereFixture ()

std::string	absco_4d_dir () const
	Location of absco 4d table. More...

std::string	absco_data_dir () const
	Location of absco table. More...

void	add_file_to_cleanup (const std::string &Fname)

SpectralDomain	highres_grid (int Spec_index) const

DoubleWithUnit	ils_half_width (int Spec_index) const
	Useful function that appears in a few tests, so collect here. More...

std::string	input_dir () const
	Directory where input data such as static input files and default Lua configuration files are located. More...

SpectralDomain	lowres_grid (int Spec_index) const

std::string	merra_data_dir () const
	Location of merra data. More...

void	set_surface_pressure (double x)
	Set the surface pressure of the atmosphere. More...

int	state_vector_size () const

std::string	test_data_dir () const
	Directory where test data is. More...

void	turn_on_logger () const
	Normally log messages don't go anywhere, so we don't clutter our unit test output. More...

Public Attributes
boost::shared_ptr< AtmosphereOco >	atm
	Atmosphere read from ConfigurationFixture. More...

boost::shared_ptr< Absorber >	config_absorber

boost::shared_ptr< Aerosol >	config_aerosol

boost::shared_ptr< RtAtmosphere >	config_atmosphere

boost::shared_ptr< ErrorAnalysis >	config_error_analysis

boost::shared_ptr< ForwardModel >	config_forward_model

boost::shared_ptr< Ground >	config_ground

boost::shared_ptr< InitialGuess >	config_initial_guess

boost::shared_ptr< Instrument >	config_instrument

boost::shared_ptr< Level1bSampleCoefficient >	config_level_1b

boost::shared_ptr< Observation >	config_observation

boost::shared_ptr< Pressure >	config_pressure

boost::shared_ptr< PressureLevelInput >	config_pressure_level_input

std::vector< boost::shared_ptr< RegisterOutputBase > >	config_register_output

boost::shared_ptr< RadiativeTransfer >	config_rt

boost::shared_ptr< ConnorSolver >	config_solver

boost::shared_ptr< SpectralWindow >	config_spectral_window

boost::shared_ptr< SpectrumSampling >	config_spectrum_sampling

boost::shared_ptr< StateVector >	config_state_vector

boost::shared_ptr< Temperature >	config_temperature

blitz::Array< double, 1 >	epsilon
	This is an epsilon that can be used to generate finite difference Jacobians for unit tests. More...

LuabindObject	lua_config

boost::shared_ptr< PressureLevelInput >	press_level
	Pressure levels we have input data on. More...

boost::shared_ptr< StateVector >	statev
	Statevector that atm is attached as an observer. More...

Detailed Description

This is a test fixture that creates an Atmosphere and related Statevector based on the unit test data set up in ConfigurationFixture.

This is pretty similar to ConfigurationFixture, but we have created a state vector that just has a clone of the Atmosphere. The Atmsosphere clone gets created each time this Fixture is created, so we have a clean Atmosphere for testing (a previous test might have purposely put the Atmosphere in an error state). If you don't need a clean new Atmosphere each time, you might just want to use ConfigurationFixture.

Definition at line 22 of file atmosphere_fixture.h.

Constructor & Destructor Documentation

◆ AtmosphereFixture()

AtmosphereFixture::AtmosphereFixture ( )

Definition at line 6 of file atmosphere_fixture.cc.

◆ ~AtmosphereFixture()

virtual FullPhysics::AtmosphereFixture::~AtmosphereFixture ( )

inlinevirtual

Definition at line 25 of file atmosphere_fixture.h.

Member Function Documentation

◆ absco_4d_dir()

std::string GlobalFixture::absco_4d_dir ( ) const

inherited

Location of absco 4d table.

Note that all of the Absco is going to be 4d in the future, so this can eventually go away. But for now most of the unit tests are 3d except for the few depending on the newer 4d tables.

Definition at line 140 of file global_fixture.cc.

◆ absco_data_dir()

std::string GlobalFixture::absco_data_dir ( ) const

inherited

Location of absco table.

Definition at line 101 of file global_fixture.cc.

◆ add_file_to_cleanup()

void FullPhysics::GlobalFixture::add_file_to_cleanup ( const std::string & Fname )

inlineinherited

Definition at line 23 of file global_fixture.h.

◆ highres_grid()

SpectralDomain FullPhysics::ConfigurationFixture::highres_grid ( int Spec_index ) const

inlineinherited

Definition at line 67 of file configuration_fixture.h.

◆ ils_half_width()

DoubleWithUnit FullPhysics::ConfigurationFixture::ils_half_width ( int Spec_index ) const

inlineinherited

Useful function that appears in a few tests, so collect here.

Definition at line 62 of file configuration_fixture.h.

◆ input_dir()

std::string GlobalFixture::input_dir ( ) const

inherited

Directory where input data such as static input files and default Lua configuration files are located.

Definition at line 63 of file global_fixture.cc.

◆ lowres_grid()

SpectralDomain FullPhysics::ConfigurationFixture::lowres_grid ( int Spec_index ) const

inlineinherited

Definition at line 64 of file configuration_fixture.h.

◆ merra_data_dir()

std::string GlobalFixture::merra_data_dir ( ) const

inherited

Location of merra data.

Definition at line 119 of file global_fixture.cc.

◆ set_surface_pressure()

void AtmosphereFixture::set_surface_pressure ( double x )

Set the surface pressure of the atmosphere.

Definition at line 22 of file atmosphere_fixture.cc.

◆ state_vector_size()

int FullPhysics::AtmosphereFixture::state_vector_size ( ) const

inline

Definition at line 38 of file atmosphere_fixture.h.

◆ test_data_dir()

std::string GlobalFixture::test_data_dir ( ) const

inherited

Directory where test data is.

This already includes the trailing slash, so you can just do test_data_data() + "foo.txt" in your unit tests.

Definition at line 83 of file global_fixture.cc.

◆ turn_on_logger()

void GlobalFixture::turn_on_logger ( ) const

inherited

Normally log messages don't go anywhere, so we don't clutter our unit test output.

But in some cases you may want to the logger turned on. This automatically gets turned off again at the end of the unit test.

Definition at line 52 of file global_fixture.cc.

Member Data Documentation

◆ atm

boost::shared_ptr<AtmosphereOco> FullPhysics::AtmosphereFixture::atm

Atmosphere read from ConfigurationFixture.

Definition at line 28 of file atmosphere_fixture.h.

◆ config_absorber

boost::shared_ptr<Absorber> FullPhysics::ConfigurationFixture::config_absorber

inherited

Definition at line 41 of file configuration_fixture.h.

◆ config_aerosol

boost::shared_ptr<Aerosol> FullPhysics::ConfigurationFixture::config_aerosol

inherited

Definition at line 42 of file configuration_fixture.h.

◆ config_atmosphere

boost::shared_ptr<RtAtmosphere> FullPhysics::ConfigurationFixture::config_atmosphere

inherited

Definition at line 43 of file configuration_fixture.h.

◆ config_error_analysis

boost::shared_ptr<ErrorAnalysis> FullPhysics::ConfigurationFixture::config_error_analysis

inherited

Definition at line 46 of file configuration_fixture.h.

◆ config_forward_model

boost::shared_ptr<ForwardModel> FullPhysics::ConfigurationFixture::config_forward_model

inherited

Definition at line 57 of file configuration_fixture.h.

◆ config_ground

boost::shared_ptr<Ground> FullPhysics::ConfigurationFixture::config_ground

inherited

Definition at line 56 of file configuration_fixture.h.

◆ config_initial_guess

boost::shared_ptr<InitialGuess> FullPhysics::ConfigurationFixture::config_initial_guess

inherited

Definition at line 49 of file configuration_fixture.h.

◆ config_instrument

boost::shared_ptr<Instrument> FullPhysics::ConfigurationFixture::config_instrument

inherited

Definition at line 51 of file configuration_fixture.h.

◆ config_level_1b

boost::shared_ptr<Level1bSampleCoefficient> FullPhysics::ConfigurationFixture::config_level_1b

inherited

Definition at line 55 of file configuration_fixture.h.

◆ config_observation

boost::shared_ptr<Observation> FullPhysics::ConfigurationFixture::config_observation

inherited

Definition at line 58 of file configuration_fixture.h.

◆ config_pressure

boost::shared_ptr<Pressure> FullPhysics::ConfigurationFixture::config_pressure

inherited

Definition at line 52 of file configuration_fixture.h.

◆ config_pressure_level_input

boost::shared_ptr<PressureLevelInput> FullPhysics::ConfigurationFixture::config_pressure_level_input

inherited

Definition at line 45 of file configuration_fixture.h.

◆ config_register_output

std::vector<boost::shared_ptr<RegisterOutputBase> > FullPhysics::ConfigurationFixture::config_register_output

inherited

Definition at line 50 of file configuration_fixture.h.

◆ config_rt

boost::shared_ptr<RadiativeTransfer> FullPhysics::ConfigurationFixture::config_rt

inherited

Definition at line 59 of file configuration_fixture.h.

◆ config_solver

boost::shared_ptr<ConnorSolver> FullPhysics::ConfigurationFixture::config_solver

inherited

Definition at line 47 of file configuration_fixture.h.

◆ config_spectral_window

boost::shared_ptr<SpectralWindow> FullPhysics::ConfigurationFixture::config_spectral_window

inherited

Definition at line 48 of file configuration_fixture.h.

◆ config_spectrum_sampling

boost::shared_ptr<SpectrumSampling> FullPhysics::ConfigurationFixture::config_spectrum_sampling

inherited

Definition at line 54 of file configuration_fixture.h.

◆ config_state_vector

boost::shared_ptr<StateVector> FullPhysics::ConfigurationFixture::config_state_vector

inherited

Definition at line 44 of file configuration_fixture.h.

◆ config_temperature

boost::shared_ptr<Temperature> FullPhysics::ConfigurationFixture::config_temperature

inherited

Definition at line 53 of file configuration_fixture.h.

◆ epsilon

blitz::Array<double, 1> FullPhysics::ConfigurationFixture::epsilon

inherited

This is an epsilon that can be used to generate finite difference Jacobians for unit tests.

Definition at line 73 of file configuration_fixture.h.

◆ lua_config

LuabindObject FullPhysics::ConfigurationFixture::lua_config

inherited

Definition at line 75 of file configuration_fixture.h.

◆ press_level

boost::shared_ptr<PressureLevelInput> FullPhysics::AtmosphereFixture::press_level

Pressure levels we have input data on.

Definition at line 31 of file atmosphere_fixture.h.

◆ statev

boost::shared_ptr<StateVector> FullPhysics::AtmosphereFixture::statev

Statevector that atm is attached as an observer.

Definition at line 36 of file atmosphere_fixture.h.

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

Implementation/atmosphere_fixture.h
Implementation/atmosphere_fixture.cc

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AtmosphereFixture()

◆ ~AtmosphereFixture()

Member Function Documentation

◆ absco_4d_dir()

◆ absco_data_dir()

◆ add_file_to_cleanup()

◆ highres_grid()

◆ ils_half_width()

◆ input_dir()

◆ lowres_grid()

◆ merra_data_dir()

◆ set_surface_pressure()

◆ state_vector_size()

◆ test_data_dir()

◆ turn_on_logger()

Member Data Documentation

◆ atm

◆ config_absorber

◆ config_aerosol

◆ config_atmosphere

◆ config_error_analysis

◆ config_forward_model

◆ config_ground

◆ config_initial_guess

◆ config_instrument

◆ config_level_1b

◆ config_observation

◆ config_pressure

◆ config_pressure_level_input

◆ config_register_output

◆ config_rt

◆ config_solver

◆ config_spectral_window

◆ config_spectrum_sampling

◆ config_state_vector

◆ config_temperature

◆ epsilon

◆ lua_config

◆ press_level

◆ statev