 |
|
Class documentation of Concepts
#include <blockOperator.hh>
Public Types | |
| typedef F | type |
| Type of data, e.g. matrix entries. | |
| typedef Realtype< F >::type | r_type |
| Real type of data type. | |
| typedef Cmplxtype< F >::type | c_type |
| Real type of data type. | |
Public Member Functions | |
| BlockOperator (concepts::Operator< F > *A=0, concepts::Operator< F > *B=0, concepts::Operator< F > *C=0, concepts::Operator< F > *D=0) | |
| BlockOperator (uint dimX, uint dimY, concepts::Operator< F > *A=0, concepts::Operator< F > *B=0, concepts::Operator< F > *C=0, concepts::Operator< F > *D=0) | |
| virtual void | operator() (const concepts::Function< F > &fncY, concepts::Function< F > &fncX) |
| Application operator for functions. | |
| void | operator() (const concepts::Vector< F > &fncY, concepts::Vector< F > &fncX) |
| Application operator for vectors. | |
| virtual void | operator() (const Function< c_type > &fncY, Function< c_type > &fncX) |
| virtual void | operator() () |
| virtual const uint | dimX () const |
| virtual const uint | dimY () const |
| virtual void | show_messages () |
Protected Member Functions | |
| virtual std::ostream & | info (std::ostream &os) const |
| Returns information in an output stream. | |
Protected Attributes | |
| uint | dimX_ |
| Dimension of image space and the source space. | |
| uint | dimY_ |
Detailed Description
class vectorial::BlockOperator< F >
Operator defined by 4 operators arranged in 2x2 blocks:
![\[ \left(\begin{array}{lr}A&B\\C&D\end{array}\right) \]](form_789_dark.png)
. BlockOperator is an Operator on a vectorial::Space of vectorial dimension 2, consisting of, say, spc1 and spc2. A is an operator spc1->spc1, B is spc2->spc1, C is spc1->spc2 and D is spc2->spc2. This is useful for example in mixed FEM for the Stokes problem, where spc1 is the space of velocities and spc2 is the space of pressures. spc1 is then again a vectorial::Space.
Definition at line 29 of file blockOperator.hh.
Member Typedef Documentation
◆ c_type
|
inherited |
Real type of data type.
Definition at line 49 of file compositions.hh.
◆ r_type
|
inherited |
Real type of data type.
Definition at line 47 of file compositions.hh.
◆ type
|
inherited |
Type of data, e.g. matrix entries.
Definition at line 45 of file compositions.hh.
Constructor & Destructor Documentation
◆ BlockOperator() [1/2]
| vectorial::BlockOperator< F >::BlockOperator | ( | concepts::Operator< F > * | A = 0, |
| concepts::Operator< F > * | B = 0, |
||
| concepts::Operator< F > * | C = 0, |
||
| concepts::Operator< F > * | D = 0 |
||
| ) |
Constructor.
- Parameters
-
A Upper left sub-operator B Upper right sub-operator C Lower left sub-operator D Lower right sub-operator
◆ BlockOperator() [2/2]
| vectorial::BlockOperator< F >::BlockOperator | ( | uint | dimX, |
| uint | dimY, | ||
| concepts::Operator< F > * | A = 0, |
||
| concepts::Operator< F > * | B = 0, |
||
| concepts::Operator< F > * | C = 0, |
||
| concepts::Operator< F > * | D = 0 |
||
| ) |
Constructor of an operator with dimX colums and dimY rows, where at least one sub-operator has to be given.
- Parameters
-
dim Dimension in both directions A Upper left sub-operator B Upper right sub-operator C Lower left sub-operator D Lower right sub-operator
Member Function Documentation
◆ dimX()
|
inlinevirtualinherited |
Returns the size of the image space of the operator (number of rows of the corresponding matrix)
- Examples
- hpFEM2d-simple.cc, hpFEM2d.cc, and matfileTutorial.cc.
Definition at line 93 of file compositions.hh.
◆ dimY()
|
inlinevirtualinherited |
Returns the size of the source space of the operator (number of columns of the corresponding matrix)
- Examples
- matfileTutorial.cc.
Definition at line 98 of file compositions.hh.
◆ info()
|
protectedvirtual |
Returns information in an output stream.
Reimplemented from concepts::Operator< F >.
◆ operator()() [1/3]
|
virtualinherited |
Application operator without argument
Reimplemented in concepts::BelosSolver< T >, concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, and concepts::VecOperator< T >.
◆ operator()() [2/3]
|
virtual |
Application operator for functions.
Reimplemented from concepts::Operator< F >.
◆ operator()() [3/3]
|
virtualinherited |
Application operator for complex function fncY.
Computes fncX = A(fncY) where A is this operator. fncX becomes complex.
In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.
If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.
Reimplemented in concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, concepts::VecOperator< T >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, concepts::Transpose< F >, concepts::Matrix< F >, concepts::Matrix< F::type >, concepts::Matrix< FX >, concepts::Matrix< Real >, and concepts::DiagonalSolver< F >.
◆ show_messages()
|
inlinevirtualinherited |
Reimplemented in concepts::MumpsOverlap< F >.
Definition at line 100 of file compositions.hh.
Member Data Documentation
◆ dimX_
|
protectedinherited |
Dimension of image space and the source space.
Definition at line 104 of file compositions.hh.
◆ dimY_
|
protectedinherited |
Definition at line 104 of file compositions.hh.
The documentation for this class was generated from the following file:
- vectorial/blockOperator.hh
Generated on Wed Sep 13 2023 21:07:00 for Concepts by
1.9.8