FullPhysics::L2FpConfiguration Class Reference

Before running L2 full physics, we need to create the solver that we will be using, along with registering whatever output we will be generating. More...

#include <l2_fp_configuration.h>

Inheritance diagram for FullPhysics::L2FpConfiguration:

Collaboration diagram for FullPhysics::L2FpConfiguration:

Public Member Functions
virtual	~L2FpConfiguration ()
virtual boost::shared_ptr< ForwardModel >	forward_model () const =0
	Forward model. Everything should be initialized to the initial guess. More...
virtual boost::shared_ptr< InitialGuess >	initial_guess () const =0
	Initial guess. More...
virtual boost::shared_ptr< IterativeSolver >	iterative_solver () const =0
	Iterative solver. More...
virtual boost::shared_ptr< LogImp >	logger () const =0
	Logger to use. More...
virtual boost::shared_ptr< MaxAPosteriori >	max_a_posteriori () const =0
	Maximum a posteriori. More...
virtual void	output (boost::shared_ptr< Output > &Regular_output, boost::shared_ptr< Output > &Error_output) const =0
	Create output, for both a normal run and for an error run (either or both can be null if we don't want output). More...
virtual void	print (std::ostream &Os) const
std::string	print_to_string () const
	Print to string. More...
virtual boost::shared_ptr< ConnorSolver >	solver () const =0
	Solver. More...

Detailed Description

Before running L2 full physics, we need to create the solver that we will be using, along with registering whatever output we will be generating.

This class gives the minimum interface needed for the configuration, so we can use different methods of actually doing this.

Definition at line 25 of file l2_fp_configuration.h.

Constructor & Destructor Documentation

~L2FpConfiguration()

virtual FullPhysics::L2FpConfiguration::~L2FpConfiguration ( )

inlinevirtual

Definition at line 27 of file l2_fp_configuration.h.

Member Function Documentation

forward_model()

virtual boost::shared_ptr<ForwardModel> FullPhysics::L2FpConfiguration::forward_model ( ) const

pure virtual

Forward model. Everything should be initialized to the initial guess.

Implemented in FullPhysics::L2FpConfigurationLua.

initial_guess()

virtual boost::shared_ptr<InitialGuess> FullPhysics::L2FpConfiguration::initial_guess ( ) const

pure virtual

Initial guess.

Implemented in FullPhysics::L2FpConfigurationLua.

iterative_solver()

virtual boost::shared_ptr<IterativeSolver> FullPhysics::L2FpConfiguration::iterative_solver ( ) const

pure virtual

Iterative solver.

Implemented in FullPhysics::L2FpConfigurationLua.

logger()

virtual boost::shared_ptr<LogImp> FullPhysics::L2FpConfiguration::logger ( ) const

pure virtual

Logger to use.

Implemented in FullPhysics::L2FpConfigurationLua.

max_a_posteriori()

virtual boost::shared_ptr<MaxAPosteriori> FullPhysics::L2FpConfiguration::max_a_posteriori ( ) const

pure virtual

Maximum a posteriori.

Implemented in FullPhysics::L2FpConfigurationLua.

output()

virtual void FullPhysics::L2FpConfiguration::output ( boost::shared_ptr< Output > &  Regular_output, boost::shared_ptr< Output > &  Error_output  ) const

pure virtual

Create output, for both a normal run and for an error run (either or both can be null if we don't want output).

This should have all the RegisterOutputBase applied to it that the configuration says should be.

Implemented in FullPhysics::L2FpConfigurationLua.

print()

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

inlinevirtual

Reimplemented in FullPhysics::L2FpConfigurationLua.

Definition at line 75 of file l2_fp_configuration.h.

print_to_string()

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

solver()

virtual boost::shared_ptr<ConnorSolver> FullPhysics::L2FpConfiguration::solver ( ) const

pure virtual

Solver.

Implemented in FullPhysics::L2FpConfigurationLua.

---

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

• Implementation/l2_fp_configuration.h