ReFRACtor
FullPhysics::InitialGuessBuilder Class Referenceabstract

Class that builds a portion of the state vector. More...

#include <composite_initial_guess.h>

+ Inheritance diagram for FullPhysics::InitialGuessBuilder:
+ Collaboration diagram for FullPhysics::InitialGuessBuilder:

Public Member Functions

virtual ~InitialGuessBuilder ()
 
virtual void attach_notify (CompositeInitialGuess &Comp_ig)
 Called when we get attached to a CompositeInitialGuess. More...
 
virtual void build_apriori (blitz::Array< double, 1 > &v, int index) const =0
 Called when we need this class to do its part in setting up the apriori state vector. More...
 
virtual void build_apriori_covariance (blitz::Array< double, 2 > &m, int index) const =0
 Called when we need this class to do its part in setting up the covariance matrix for the a priori state vector. More...
 
virtual void build_initial_value (blitz::Array< double, 1 > &v, int index) const =0
 Called when we need this class to do its part in setting up the initial state vector. More...
 
virtual int number_element () const =0
 Number of elements we will be adding to the state vector. More...
 
virtual void print (std::ostream &Os) const
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

Class that builds a portion of the state vector.

We use a std::vector here rather than a blitz::Array just because it is easier to add something to the end of std::vector than blitz::Array. CompositeInitialGuess converts this to a blitz::Array before finishing the construction of the initial guess.

Definition at line 19 of file composite_initial_guess.h.

Constructor & Destructor Documentation

◆ ~InitialGuessBuilder()

virtual FullPhysics::InitialGuessBuilder::~InitialGuessBuilder ( )
inlinevirtual

Definition at line 21 of file composite_initial_guess.h.

Member Function Documentation

◆ attach_notify()

virtual void FullPhysics::InitialGuessBuilder::attach_notify ( CompositeInitialGuess Comp_ig)
inlinevirtual

Called when we get attached to a CompositeInitialGuess.

The default is to do nothing, but derived classes can override this if desired.

Definition at line 28 of file composite_initial_guess.h.

◆ build_apriori()

virtual void FullPhysics::InitialGuessBuilder::build_apriori ( blitz::Array< double, 1 > &  v,
int  index 
) const
pure virtual

Called when we need this class to do its part in setting up the apriori state vector.

Parameters
vState vector that should be updated in place.
indexSince we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implemented in FullPhysics::CompositeInitialGuess, and FullPhysics::InitialGuessValue.

◆ build_apriori_covariance()

virtual void FullPhysics::InitialGuessBuilder::build_apriori_covariance ( blitz::Array< double, 2 > &  m,
int  index 
) const
pure virtual

Called when we need this class to do its part in setting up the covariance matrix for the a priori state vector.

Parameters
mState vector that should be updated in place.
indexSince we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implemented in FullPhysics::CompositeInitialGuess, and FullPhysics::InitialGuessValue.

◆ build_initial_value()

virtual void FullPhysics::InitialGuessBuilder::build_initial_value ( blitz::Array< double, 1 > &  v,
int  index 
) const
pure virtual

Called when we need this class to do its part in setting up the initial state vector.

Parameters
vState vector that should be updated in place.
indexSince we are often adding to the end of the state vector, index is passed in. This is the sum of the number_elements() of all the InitialGuessBuilder that appear before this object in the list.

Implemented in FullPhysics::CompositeInitialGuess, and FullPhysics::InitialGuessValue.

◆ number_element()

virtual int FullPhysics::InitialGuessBuilder::number_element ( ) const
pure virtual

Number of elements we will be adding to the state vector.

0 is a legal value, if we are changing elements but not adding any.

Implemented in FullPhysics::CompositeInitialGuess, and FullPhysics::InitialGuessValue.

◆ print()

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

◆ print_to_string()

std::string FullPhysics::Printable< InitialGuessBuilder >::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 file:

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:12