ug4
assembled_linear_operator.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010-2015: G-CSC, Goethe University Frankfurt
3  * Author: Andreas Vogel
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__LIB_DISC__OPERATOR__LINEAR_OPERATOR__ASSEMBLED_LINEAR_OPERATOR__
34 #define __H__UG__LIB_DISC__OPERATOR__LINEAR_OPERATOR__ASSEMBLED_LINEAR_OPERATOR__
35 
38 
39 #ifdef UG_PARALLEL
41 #endif
42 
44 
45 namespace ug{
46 
48 
56 template <typename TAlgebra>
58  public virtual MatrixOperator< typename TAlgebra::matrix_type,
59  typename TAlgebra::vector_type>
60 {
61  public:
63  typedef TAlgebra algebra_type;
64 
66  typedef typename TAlgebra::vector_type vector_type;
67 
69  typedef typename TAlgebra::matrix_type matrix_type;
70 
73 
74  public:
77 
80 
83  : m_spAss(ass), m_gridLevel(gl) {};
84 
87 
90 
92  void set_level(const GridLevel& gl) {m_gridLevel = gl;}
93 
95  const GridLevel& level() const {return m_gridLevel;}
96 
98  virtual void init(const vector_type& u);
99 
101  virtual void init();
102 
104  void init_op_and_rhs(vector_type& b);
105 
107  virtual void apply(vector_type& d, const vector_type& c);
108 
110  virtual void apply_sub(vector_type& d, const vector_type& c);
111 
114 
117 
118  protected:
119  // assembling procedure
121 
122  // DoF Distribution used
124 };
125 
128 
130 
140 template <typename TAlgebra>
143  typename TAlgebra::vector_type& u,
144  typename TAlgebra::vector_type& b);
145 
146 } // namespace ug
147 
148 // include implementation
150 
151 #endif /* __H__UG__LIB_DISC__OPERATOR__LINEAR_OPERATOR__ASSEMBLED_LINEAR_OPERATOR__ */
Definition: smart_pointer.h:108
matrix operator based on the assembling of a problem
Definition: assembled_linear_operator.h:60
SmartPtr< IAssemble< TAlgebra > > discretization()
returns the discretization to be used
Definition: assembled_linear_operator.h:89
MatrixOperator< matrix_type, vector_type > base_type
Type of base class.
Definition: assembled_linear_operator.h:72
AssembledLinearOperator(SmartPtr< IAssemble< TAlgebra > > ass)
Constructor.
Definition: assembled_linear_operator.h:79
AssembledLinearOperator()
Default Constructor.
Definition: assembled_linear_operator.h:76
void init_op_and_rhs(vector_type &b)
initializes the operator and assembles the passed rhs vector
Definition: assembled_linear_operator_impl.h:87
TAlgebra::vector_type vector_type
Type of Vector.
Definition: assembled_linear_operator.h:66
virtual void apply_sub(vector_type &d, const vector_type &c)
Compute d := d - J(u)*c.
Definition: assembled_linear_operator_impl.h:125
TAlgebra::matrix_type matrix_type
Type of Matrix.
Definition: assembled_linear_operator.h:69
TAlgebra algebra_type
Type of Algebra.
Definition: assembled_linear_operator.h:63
AssembledLinearOperator(SmartPtr< IAssemble< TAlgebra > > ass, const GridLevel &gl)
Constructor.
Definition: assembled_linear_operator.h:82
void set_level(const GridLevel &gl)
sets the level used for assembling
Definition: assembled_linear_operator.h:92
const GridLevel & level() const
returns the level
Definition: assembled_linear_operator.h:95
virtual void init()
initialize the operator
Definition: assembled_linear_operator_impl.h:69
void set_discretization(SmartPtr< IAssemble< TAlgebra > > ass)
sets the discretization to be used
Definition: assembled_linear_operator.h:86
virtual void apply(vector_type &d, const vector_type &c)
compute d = J(u)*c (here, J(u) is a Matrix)
Definition: assembled_linear_operator_impl.h:104
virtual ~AssembledLinearOperator()
Destructor.
Definition: assembled_linear_operator.h:116
GridLevel m_gridLevel
Definition: assembled_linear_operator.h:123
void set_dirichlet_values(vector_type &u)
Set Dirichlet values.
Definition: assembled_linear_operator_impl.h:147
SmartPtr< IAssemble< TAlgebra > > m_spAss
Definition: assembled_linear_operator.h:116
Definition: grid_level.h:42
Interface providing Jacobian and Defect of a discretization.
Definition: assemble_interface.h:110
Definition: matrix_operator.h:49
CPUAlgebra::vector_type vector_type
the ug namespace
void AssembleLinearOperatorRhsAndSolution(AssembledLinearOperator< TAlgebra > &op, typename TAlgebra::vector_type &u, typename TAlgebra::vector_type &b)
help function to assemble a linear operator
Definition: assembled_linear_operator_impl.h:167