ReFRACtor
FullPhysics::Perturbation Class Referenceabstract

This gets the perturbation to use with a finite difference Jacobian. More...

#include <perturbation.h>

+ Inheritance diagram for FullPhysics::Perturbation:
+ Collaboration diagram for FullPhysics::Perturbation:

Public Member Functions

virtual ~Perturbation ()
 
virtual blitz::Array< double, 1 > perturbation () const =0
 Return the perturbation vector to use. More...
 
virtual void print (std::ostream &Os) const
 Print description of object. More...
 
std::string print_to_string () const
 Print to string. More...
 

Detailed Description

This gets the perturbation to use with a finite difference Jacobian.

Definition at line 10 of file perturbation.h.

Constructor & Destructor Documentation

◆ ~Perturbation()

virtual FullPhysics::Perturbation::~Perturbation ( )
inlinevirtual

Definition at line 12 of file perturbation.h.

Member Function Documentation

◆ perturbation()

virtual blitz::Array<double, 1> FullPhysics::Perturbation::perturbation ( ) const
pure virtual

Return the perturbation vector to use.

Implemented in FullPhysics::CompositePerturbation.

◆ print()

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

Print description of object.

Reimplemented in FullPhysics::CompositePerturbation.

Definition at line 24 of file perturbation.h.

◆ print_to_string()

std::string FullPhysics::Printable< Perturbation >::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:13