This class wraps su2activematrix for the python wrapper matrix interface restricting it to the vertices of a given marker.
More...
#include <CPyWrapperMatrixView.hpp>
|
| | CPyWrapperMarkerMatrixView ()=default |
| |
| | CPyWrapperMarkerMatrixView (su2activematrix &mat, const CVertex *const *vertices, unsigned long n_vertices, const std::string &name, bool read_only) |
| | Construct the view of the matrix.
|
| |
| std::pair< unsigned long, unsigned long > | Shape () const |
| | Returns the shape of the matrix.
|
| |
| bool | IsReadOnly () const |
| | Returns whether the data is read-only [true] or if it can be modified [false].
|
| |
| passivedouble | operator() (unsigned long row, unsigned long col) const |
| | Gets the value for a (row, column) pair.
|
| |
| std::vector< passivedouble > | operator() (unsigned long row) const |
| | Gets the values for a row of the matrix.
|
| |
| passivedouble | Get (unsigned long row, unsigned long col) const |
| | Gets the value for a (row, column) pair.
|
| |
| std::vector< passivedouble > | Get (unsigned long row) const |
| | Gets the values for a row of the matrix.
|
| |
| void | Set (unsigned long row, unsigned long col, passivedouble val) |
| | Sets the value for a (row, column) pair. This clears derivative information.
|
| |
| void | Set (unsigned long row, std::vector< passivedouble > vals) |
| | Sets the values for a row of the matrix.
|
| |
This class wraps su2activematrix for the python wrapper matrix interface restricting it to the vertices of a given marker.
◆ CPyWrapperMarkerMatrixView() [1/2]
| CPyWrapperMarkerMatrixView::CPyWrapperMarkerMatrixView |
( |
| ) |
|
|
default |
◆ CPyWrapperMarkerMatrixView() [2/2]
| CPyWrapperMarkerMatrixView::CPyWrapperMarkerMatrixView |
( |
su2activematrix & |
mat, |
|
|
const CVertex *const * |
vertices, |
|
|
unsigned long |
n_vertices, |
|
|
const std::string & |
name, |
|
|
bool |
read_only |
|
) |
| |
|
inline |
Construct the view of the matrix.
- Note
- "name" should be set to the variable name being returned to give better information to users.
-
"read_only" can be set to true to prevent the data from being modified.
◆ Get() [1/2]
| std::vector< passivedouble > CPyWrapperMarkerMatrixView::Get |
( |
unsigned long |
row | ) |
const |
|
inline |
Gets the values for a row of the matrix.
◆ Get() [2/2]
| passivedouble CPyWrapperMarkerMatrixView::Get |
( |
unsigned long |
row, |
|
|
unsigned long |
col |
|
) |
| const |
|
inline |
Gets the value for a (row, column) pair.
◆ IsReadOnly()
| bool CPyWrapperMarkerMatrixView::IsReadOnly |
( |
| ) |
const |
|
inline |
Returns whether the data is read-only [true] or if it can be modified [false].
◆ operator()() [1/2]
| std::vector< passivedouble > CPyWrapperMarkerMatrixView::operator() |
( |
unsigned long |
row | ) |
const |
|
inline |
Gets the values for a row of the matrix.
◆ operator()() [2/2]
| passivedouble CPyWrapperMarkerMatrixView::operator() |
( |
unsigned long |
row, |
|
|
unsigned long |
col |
|
) |
| const |
|
inline |
Gets the value for a (row, column) pair.
◆ Set() [1/2]
| void CPyWrapperMarkerMatrixView::Set |
( |
unsigned long |
row, |
|
|
std::vector< passivedouble > |
vals |
|
) |
| |
|
inline |
Sets the values for a row of the matrix.
◆ Set() [2/2]
| void CPyWrapperMarkerMatrixView::Set |
( |
unsigned long |
row, |
|
|
unsigned long |
col, |
|
|
passivedouble |
val |
|
) |
| |
|
inline |
Sets the value for a (row, column) pair. This clears derivative information.
◆ Shape()
| std::pair< unsigned long, unsigned long > CPyWrapperMarkerMatrixView::Shape |
( |
| ) |
const |
|
inline |
Returns the shape of the matrix.
The documentation for this class was generated from the following file:
1.9.8