libMesh::SensitivityData Class Reference

Data structure for holding completed parameter sensitivity calculations. More...

#include <sensitivity_data.h>

Classes
class	ConstRow
class	Row

Public Member Functions
	SensitivityData ()
	Default constructor: empty data set. More...
	SensitivityData (const QoISet &qoi_indices, const System &sys, const ParameterVector &parameter_vector)
	Constructor from QoISet and ParameterVector: allocates space for all required sensitivities. More...
void	clear ()
	Clears and deallocates all data. More...
void	allocate_data (const QoISet &qoi_indices, const System &sys, const ParameterVector &parameter_vector)
	Given QoISet and ParameterVector, allocates space for all required first derivative data. More...
void	allocate_hessian_data (const QoISet &qoi_indices, const System &sys, const ParameterVector &parameter_vector)
	Given QoISet and ParameterVector, allocates space for all required second derivative data. More...
const Number &	derivative (unsigned int qoi_index, unsigned int parameter_index) const
const Number &	second_derivative (unsigned int qoi_index, unsigned int parameter_index1, unsigned int parameter_index2) const
Number &	derivative (unsigned int qoi_index, unsigned int parameter_index)
	Gets/sets the parameter sensitivity derivative for the specified quantity of interest for the specified parameter. More...
Number &	second_derivative (unsigned int qoi_index, unsigned int parameter_index1, unsigned int parameter_index2)
	Gets/sets the parameter sensitivity second derivative for the specified quantity of interest for the specified pair of parameters. More...
ConstRow	operator[] (unsigned int qoi) const
	Vector address type operator: sd[q][p] is an alias for sd.derivative(q,p) More...
Row	operator[] (unsigned int qoi)

Private Attributes
std::vector< std::vector< Number > >	_grad_data
	Data storage; currently pretty trivial. More...
std::vector< std::vector< std::vector< Number > > >	_hess_data

Detailed Description

Data structure for holding completed parameter sensitivity calculations.

Author

Roy Stogner

Date

2009 Holds completed parameter sensitivity calculations.

Definition at line 46 of file sensitivity_data.h.

Constructor & Destructor Documentation

SensitivityData() [1/2]

libMesh::SensitivityData::SensitivityData ( )

inline

Default constructor: empty data set.

Definition at line 74 of file sensitivity_data.h.

{}

SensitivityData() [2/2]

libMesh::SensitivityData::SensitivityData ( const QoISet &  qoi_indices, const System &  sys, const ParameterVector &  parameter_vector  )

inline

Constructor from QoISet and ParameterVector: allocates space for all required sensitivities.

Definition at line 160 of file sensitivity_data.h.

References allocate_data().

{
  this->allocate_data(qoi_indices, sys, parameter_vector);
}

Member Function Documentation

allocate_data()

void libMesh::SensitivityData::allocate_data ( const QoISet &  qoi_indices, const System &  sys, const ParameterVector &  parameter_vector  )

inline

Given QoISet and ParameterVector, allocates space for all required first derivative data.

Definition at line 170 of file sensitivity_data.h.

References _grad_data, libMesh::QoISet::has_index(), libMesh::System::n_qois(), and libMesh::ParameterVector::size().

Referenced by libMesh::ImplicitSystem::adjoint_qoi_parameter_sensitivity(), libMesh::ImplicitSystem::forward_qoi_parameter_sensitivity(), libMesh::ImplicitSystem::qoi_parameter_hessian_vector_product(), and SensitivityData().

{
  const std::size_t Np = parameter_vector.size();
  const unsigned int Nq = sys.n_qois();

  if (_grad_data.size() < Nq)
    _grad_data.resize(Nq);

  for (unsigned int i=0; i != Nq; ++i)
    if (qoi_indices.has_index(i))
      {
        _grad_data[i].clear();
        _grad_data[i].resize(Np);
      }
}

allocate_hessian_data()

void libMesh::SensitivityData::allocate_hessian_data ( const QoISet &  qoi_indices, const System &  sys, const ParameterVector &  parameter_vector  )

inline

Given QoISet and ParameterVector, allocates space for all required second derivative data.

Definition at line 191 of file sensitivity_data.h.

References _hess_data, libMesh::QoISet::has_index(), libMesh::System::n_qois(), and libMesh::ParameterVector::size().

Referenced by libMesh::ImplicitSystem::qoi_parameter_hessian().

{
  const std::size_t Np = parameter_vector.size();
  const unsigned int Nq = sys.n_qois();

  if (_hess_data.size() < Nq)
    _hess_data.resize(Nq);

  for (unsigned int i=0; i != Nq; ++i)
    if (qoi_indices.has_index(i))
      {
        _hess_data[i].clear();
        _hess_data[i].resize(Np);
        for (std::size_t j=0; j != Np; ++j)
          _hess_data[i][j].resize(Np);
      }
}

clear()

void libMesh::SensitivityData::clear ( )

inline

Clears and deallocates all data.

Definition at line 87 of file sensitivity_data.h.

References _grad_data.

{ _grad_data.clear(); }

derivative() [1/2]

const Number & libMesh::SensitivityData::derivative ( unsigned int  qoi_index, unsigned int  parameter_index  ) const

inline

Returns

The parameter sensitivity derivative for the specified quantity of interest for the specified parameter

Definition at line 214 of file sensitivity_data.h.

References _grad_data.

Referenced by libMesh::SensitivityData::Row::operator[](), and libMesh::SensitivityData::ConstRow::operator[]().

{
  libmesh_assert_less (qoi_index, _grad_data.size());
  libmesh_assert_less (parameter_index, _grad_data[qoi_index].size());

  return _grad_data[qoi_index][parameter_index];
}

derivative() [2/2]

Number & libMesh::SensitivityData::derivative ( unsigned int  qoi_index, unsigned int  parameter_index  )

inline

Gets/sets the parameter sensitivity derivative for the specified quantity of interest for the specified parameter.

Definition at line 226 of file sensitivity_data.h.

References _grad_data.

{
  libmesh_assert_less (qoi_index, _grad_data.size());
  libmesh_assert_less (parameter_index, _grad_data[qoi_index].size());

  return _grad_data[qoi_index][parameter_index];
}

operator[]() [1/2]

ConstRow libMesh::SensitivityData::operator[] ( unsigned int  qoi ) const

inline

Vector address type operator: sd[q][p] is an alias for sd.derivative(q,p)

Definition at line 140 of file sensitivity_data.h.

{ return ConstRow(*this, qoi); }

operator[]() [2/2]

Row libMesh::SensitivityData::operator[] ( unsigned int  qoi )

inline

Definition at line 142 of file sensitivity_data.h.

{ return Row(*this, qoi); }

second_derivative() [1/2]

const Number & libMesh::SensitivityData::second_derivative ( unsigned int  qoi_index, unsigned int  parameter_index1, unsigned int  parameter_index2  ) const

inline

Returns

The parameter sensitivity derivative for the specified quantity of interest for the specified pair of parameters

Definition at line 238 of file sensitivity_data.h.

References _hess_data.

Referenced by libMesh::ImplicitSystem::qoi_parameter_hessian().

{
  libmesh_assert_less (qoi_index, _hess_data.size());
  libmesh_assert_less (parameter_index1, _hess_data[qoi_index].size());
  libmesh_assert_less (parameter_index2, _hess_data[qoi_index][parameter_index1].size());

  return _hess_data[qoi_index][parameter_index1][parameter_index2];
}

second_derivative() [2/2]

Number & libMesh::SensitivityData::second_derivative ( unsigned int  qoi_index, unsigned int  parameter_index1, unsigned int  parameter_index2  )

inline

Gets/sets the parameter sensitivity second derivative for the specified quantity of interest for the specified pair of parameters.

Definition at line 252 of file sensitivity_data.h.

References _hess_data.

{
  libmesh_assert_less (qoi_index, _hess_data.size());
  libmesh_assert_less (parameter_index1, _hess_data[qoi_index].size());
  libmesh_assert_less (parameter_index2, _hess_data[qoi_index][parameter_index1].size());

  return _hess_data[qoi_index][parameter_index1][parameter_index2];
}

Member Data Documentation

_grad_data

std::vector<std::vector<Number> > libMesh::SensitivityData::_grad_data

private

Data storage; currently pretty trivial.

Definition at line 148 of file sensitivity_data.h.

Referenced by allocate_data(), clear(), and derivative().

_hess_data

std::vector<std::vector<std::vector<Number> > > libMesh::SensitivityData::_hess_data

private

Definition at line 149 of file sensitivity_data.h.

Referenced by allocate_hessian_data(), and second_derivative().

---

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

• include/systems/sensitivity_data.h