concepts::Matrix< F > Class Template Referenceabstract
Abstract class for an operator. More...
#include <compositions.hh>
Public Types | |
typedef Cmplxtype< F >::type | c_type |
Complex type of data type. More... | |
typedef _Matrix_iterator< F, const F &, const F * > | const_iterator |
typedef std::conditional< std::is_same< typename Realtype< F >::type, F >::value, typename Realtype< F >::type, typename Cmplxtype< F >::type >::type | d_type |
Data type, depending if F is real or complex. More... | |
typedef _Matrix_iterator< F, F &, F * > | iterator |
typedef Realtype< F >::type | r_type |
Real type of data type. More... | |
typedef F | value_type |
Public Member Functions | |
virtual void | add (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8) |
Addition operator Add the value to the entry (i,j) if not zero (for use_threshold = false), or if the absolute avlue is bigger than the threshold_value (for use_threshold = true) More... | |
iterator | begin (uint r=0) |
Iterator over the elements, standing at position (r,0). More... | |
const_iterator | begin (uint r=0) const |
Constant iterator over the elements, standing at position (r,0) More... | |
iterator | end () |
Iterator, standing behind last element. More... | |
const_iterator | end () const |
Constant iterator, standing behind last element. More... | |
Matrix (uint nofRows, uint nofCols) | |
const uint | nofCols () const |
Number of columns. More... | |
const uint | nofRows () const |
Number of rows. More... | |
virtual void | operator() (const Function< c_type > &fncY, Function< c_type > &fncX)=0 |
virtual void | operator() (const Function< r_type > &fncY, Function< F > &fncX)=0 |
Computes fncX = A(fncY ) where A is this matrix. More... | |
virtual F | operator() (const uint i, const uint j) const =0 |
Returns entry with indices i and j . More... | |
virtual F & | operator() (const uint i, const uint j)=0 |
Returns and allows access to entry with indices i and j . More... | |
virtual bool | operator== (const Matrix< F > &otherMat) const |
virtual void | set (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8) |
Affectation operator Affet the value to the entry (i,j) if not zero (for use_threshold = false), or if the absolute value is bigger than the threshold_value (for use_threshold = true) More... | |
virtual void | transpMult (const Vector< c_type > &fncY, Vector< c_type > &fncX)=0 |
virtual void | transpMult (const Vector< r_type > &fncY, Vector< F > &fncX)=0 |
Computes fncX = AT fncY where A is this matrix. More... | |
Static Public Member Functions | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const BilinearForm< F, G > &bf, const ElementPairList< G > &pairs) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Sequence< ElementWithCell< G > * > seq, const BilinearForm< F, G > &bf, const Real threshold=0.0) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Sequence< ElementWithCell< G > * > seqX, const Space< G > &spcY, const BilinearForm< F, G > &bf, const Real threshold=0.0) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Space< G > &spc, const BilinearForm< F, G > &bf, const Real threshold=0.0) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Space< G > &spc, const Sequence< bool > &seq, const BilinearForm< F, G > &bf, const Real threshold=0.0) |
Assembly operator for dest using the bilinear form bf on space spc . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Space< G > &spcX, const Space< G > &spcY, const BilinearForm< F, G > &bf, const Real threshold=0.0, const bool single=false) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, const Space< G > &spcX, const Space< G > &spcY, const Sequence< bool > &seq, const BilinearForm< F, G > &bf, const Real threshold=0.0, const bool single=false) |
Assembly operator for dest using the bilinear form bf . More... | |
template<class G > | |
static void | assembly (Matrix< F > &dest, Scan< Element< G > > *sc, const BilinearForm< F, G > &bf, const Real threshold=0.0) |
Assembly operator for dest using the bilinear form bf . More... | |
Timing Interface | |
These functions are used to get timings from class internal computations. The values are stored in a user defined concepts::InOutParameters structure in different arrays (see concepts::ResultsTable table;
std::ofstream ofs("table.gnuplot");
ofs << std::setprecision(20);
table.print<concepts::ResultsTable::GNUPLOT>(ofs);
| |
static InOutParameters * | timings_ |
Place to store timing values. More... | |
static uint | timeCntr_ |
Counter for timing table. More... | |
static void | setTimings (InOutParameters *timings) |
Sets the class to store the timing values in. More... | |
static bool | timings () |
Returns true if the class is able to do timings. More... | |
Detailed Description
template<class F>
class concepts::Matrix< F >
Abstract class for an operator.
This class is equiped with an interface to get timings of internal computations if compiled accordingly (see bilinearForm.cc
file), see setTimings()
and timings()
.
Definition at line 31 of file compositions.hh.
Member Typedef Documentation
◆ c_type
typedef Cmplxtype<F>::type concepts::Matrix< F >::c_type |
◆ const_iterator
typedef _Matrix_iterator<F, const F&, const F*> concepts::Matrix< F >::const_iterator |
◆ d_type
typedef std::conditional<std::is_same<typename Realtype<F>::type, F>::value , typename Realtype<F>::type, typename Cmplxtype<F>::type >::type concepts::Matrix< F >::d_type |
◆ iterator
typedef _Matrix_iterator<F, F&, F*> concepts::Matrix< F >::iterator |
◆ r_type
typedef Realtype<F>::type concepts::Matrix< F >::r_type |
◆ value_type
typedef F concepts::Matrix< F >::value_type |
Constructor & Destructor Documentation
◆ Matrix()
|
inline |
Member Function Documentation
◆ add()
|
virtual |
Addition operator Add the value to the entry (i,j) if not zero (for use_threshold
= false), or if the absolute avlue is bigger than the threshold_value
(for use_threshold
= true)
◆ assembly() [1/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator uses the element pairs taken from pairs
. For every two elements found in a ElementPair in pairs
, the bilinear form is evaluated and the result assembled into dest
.
◆ assembly() [2/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator does not compute element matrices for two different elements. The elements are taken from the element sequence seq
.
◆ assembly() [3/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator computes also the element matrices for two different elements. The elements are taken from the element sequence seqX
for the test space, and the trial space spcY
is fully taken into account.
◆ assembly() [4/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator does not compute element matrices for two different elements. The elements are taken from the space spc
.
- Examples
- linearDG1d.cc.
◆ assembly() [5/8]
|
static |
Assembly operator for dest
using the bilinear form bf
on space spc
.
This assembly operator does not compute element matrices for two different elements. The elements are computing on the cells that are flagged by seq
.
◆ assembly() [6/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator computes also the element matrices for two different elements (coming from test space spcX
and trial space spcY
).
◆ assembly() [7/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator computes also the element matrices for two different elements (coming from test space spcX
and trial space spcY
). The elements are computing on the cells that are flagged by seq
.
◆ assembly() [8/8]
|
static |
Assembly operator for dest
using the bilinear form bf
.
This assembly operator does not compute element matrices for two different elements. The elements are taken from the space scanner sc
.
◆ begin() [1/2]
|
inline |
◆ begin() [2/2]
|
inline |
◆ end() [1/2]
|
inline |
◆ end() [2/2]
|
inline |
◆ nofCols()
|
inline |
◆ nofRows()
|
inline |
◆ operator()() [1/4]
|
pure virtual |
◆ operator()() [2/4]
|
pure virtual |
Computes fncX
= A(fncY
) where A is this matrix.
Implemented in concepts::Permutation< Real >, concepts::Transpose< F >, concepts::Permutation< F >, and concepts::DiagonalMatrix< F >.
◆ operator()() [3/4]
|
pure virtual |
Returns entry with indices i
and j
.
Implemented in concepts::Transpose< F >, concepts::PETScMat, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.
◆ operator()() [4/4]
|
pure virtual |
Returns and allows access to entry with indices i
and j
.
Implemented in concepts::Transpose< F >, concepts::PETScMat, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.
◆ operator==()
|
inlinevirtual |
◆ set()
|
virtual |
Affectation operator Affet the value to the entry (i,j) if not zero (for use_threshold
= false), or if the absolute value is bigger than the threshold_value
(for use_threshold
= true)
◆ setTimings()
|
static |
Sets the class to store the timing values in.
Additionally, the timeCntr_
is reset to 0. This counter is used to fill in the values into the arrays listed below in subsequent calls. The following timings are taken and stored in timings:
-
evaluation of bilinear form in
bilinear_form
-
application of T matrix in
tmatrix_apply
-
assembling into global matrix in
global_assembly
◆ timings()
|
static |
Returns true if the class is able to do timings.
The ability to do timings depends on a compiler switch in matrix.cc
file.
◆ transpMult() [1/2]
|
pure virtual |
◆ transpMult() [2/2]
|
pure virtual |
Computes fncX
= AT fncY
where A is this matrix.
Implemented in concepts::Permutation< Real >, concepts::Transpose< F >, concepts::Permutation< F >, and concepts::DiagonalMatrix< F >.
Member Data Documentation
◆ timeCntr_
|
staticprivate |
◆ timings_
|
staticprivate |
The documentation for this class was generated from the following files:
- operator/compositions.hh
- operator/matrix.hh