PISM, A Parallel Ice Sheet Model  stable v2.1-1-g6902d5502 committed by Ed Bueler on 2023-12-20 08:38:27 -0800
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
pism::inverse::IPMeanSquareFunctional2S Class Reference

Implements a functional corresponding to a (possibly weighted) sum of squares of components of an array::Scalar. More...

#include <IPMeanSquareFunctional.hh>

+ Inheritance diagram for pism::inverse::IPMeanSquareFunctional2S:

Public Member Functions

 IPMeanSquareFunctional2S (std::shared_ptr< const Grid > grid, array::Scalar *weights=NULL)
 
virtual ~IPMeanSquareFunctional2S ()
 
virtual void normalize (double scale)
 Implicitly set the normalization constant for the functional. More...
 
virtual void valueAt (array::Scalar &x, double *OUTPUT)
 Computes the value of the functional at the vector x. More...
 
virtual void dot (array::Scalar &a, array::Scalar &b, double *OUTPUT)
 Computes the inner product \(Q(a, b)\). More...
 
virtual void gradientAt (array::Scalar &x, array::Scalar &gradient)
 Computes the gradient of the functional at the vector x. More...
 
- Public Member Functions inherited from pism::inverse::IPInnerProductFunctional< array::Scalar >
 IPInnerProductFunctional (std::shared_ptr< const Grid > grid)
 
virtual void interior_product (array::Scalar &x, array::Scalar &y)
 Computes the interior product of a vector with the IPInnerProductFunctional's underlying bilinear form. More...
 
- Public Member Functions inherited from pism::inverse::IPFunctional< array::Scalar >
 IPFunctional (std::shared_ptr< const Grid > grid)
 
virtual ~IPFunctional ()
 

Protected Attributes

array::Scalarm_weights
 
double m_normalization
 
- Protected Attributes inherited from pism::inverse::IPFunctional< array::Scalar >
std::shared_ptr< const Gridm_grid
 
fem::ElementIterator m_element_index
 
fem::Q1Element2 m_element
 

Private Member Functions

 IPMeanSquareFunctional2S (IPMeanSquareFunctional2S const &)
 
IPMeanSquareFunctional2Soperator= (IPMeanSquareFunctional2S const &)
 

Detailed Description

Implements a functional corresponding to a (possibly weighted) sum of squares of components of an array::Scalar.

If the vector has components \(x_i\) the functional is

\[ J(x) = c_N \sum_{i} w_i x_i^2 \]

where \([w_i]\) is a vector of weights and \(c_N\) is a normalization constant. The value of the normalization constant is set implicitly by a call to normalize().

Definition at line 35 of file IPMeanSquareFunctional.hh.


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