CNumerics::ResidualType< Vector_t, Matrix_t > Struct Template Reference

Return type used in some "ComputeResidual" overloads to give a const-view of the internally stored flux vector and Jacobians to the outside. More...

#include <CNumerics.hpp>

Public Member Functions
	ResidualType ()=delete
	ResidualType (const Vector_t &res, const Matrix_t &jac_i, const Matrix_t &jac_j)
	operator Vector_t ()
	The object can be directly cast to the vector type, this allows discarding the Jacobians when they are not needed.
su2double	operator[] (unsigned long idx) const

Public Attributes
const Vector_t	residual
const Matrix_t	jacobian_i
const Matrix_t	jacobian_j

Detailed Description

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>
struct CNumerics::ResidualType< Vector_t, Matrix_t >

Return type used in some "ComputeResidual" overloads to give a const-view of the internally stored flux vector and Jacobians to the outside.

Note

The default template params make this an "all const" object, it cannot change after instantiation, nor can it be used to change the data.

Constructor & Destructor Documentation

ResidualType() [1/2]

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

CNumerics::ResidualType< Vector_t, Matrix_t >::ResidualType ( )

delete

ResidualType() [2/2]

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

CNumerics::ResidualType< Vector_t, Matrix_t >::ResidualType ( const Vector_t &  res, const Matrix_t &  jac_i, const Matrix_t &  jac_j  )

inline

Member Function Documentation

operator Vector_t()

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

CNumerics::ResidualType< Vector_t, Matrix_t >::operator Vector_t ( )

inline

The object can be directly cast to the vector type, this allows discarding the Jacobians when they are not needed.

operator[]()

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

su2double CNumerics::ResidualType< Vector_t, Matrix_t >::operator[] ( unsigned long  idx ) const

inline

Member Data Documentation

jacobian_i

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

const Matrix_t CNumerics::ResidualType< Vector_t, Matrix_t >::jacobian_i

jacobian_j

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

const Matrix_t CNumerics::ResidualType< Vector_t, Matrix_t >::jacobian_j

residual

template<class Vector_t = const su2double*, class Matrix_t = const Vector_t*>

const Vector_t CNumerics::ResidualType< Vector_t, Matrix_t >::residual

---

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

• SU2_CFD/include/numerics/CNumerics.hpp