libMesh
explicit_system.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
3 
4 // This library is free software; you can redistribute it and/or
5 // modify it under the terms of the GNU Lesser General Public
6 // License as published by the Free Software Foundation; either
7 // version 2.1 of the License, or (at your option) any later version.
8 
9 // This library is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 // Lesser General Public License for more details.
13 
14 // You should have received a copy of the GNU Lesser General Public
15 // License along with this library; if not, write to the Free Software
16 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 
18 
19 
20 #ifndef LIBMESH_EXPLICIT_SYSTEM_H
21 #define LIBMESH_EXPLICIT_SYSTEM_H
22 
23 // Local Includes
24 #include "libmesh/system.h"
25 
26 namespace libMesh
27 {
28 
48 class ExplicitSystem : public System
49 {
50 public:
51 
57  const std::string & name,
58  const unsigned int number);
59 
64 
68  typedef System Parent;
69 
73  sys_type & system () { return *this; }
74 
79  virtual void clear () override;
80 
86  virtual void assemble_qoi (const QoISet & qoi_indices = QoISet()) override;
87 
93  virtual void assemble_qoi_derivative (const QoISet & qoi_indices = QoISet(),
94  bool include_liftfunc = true,
95  bool apply_constraints = true) override;
96 
101  virtual void solve () override;
102 
107  virtual std::string system_type () const override { return "Explicit"; }
108 
115 
116 
117 private:
118 
123  void add_system_rhs ();
124 };
125 
126 } // namespace libMesh
127 
128 #endif // LIBMESH_EXPLICIT_SYSTEM_H
libMesh::System
Manages consistently variables, degrees of freedom, and coefficient vectors.
Definition: system.h:100
libMesh::ExplicitSystem::solve
virtual void solve() override
For explicit systems, just assemble the system which should directly compute A*x.
Definition: explicit_system.C:85
libMesh::ExplicitSystem::rhs
NumericVector< Number > * rhs
The system matrix.
Definition: explicit_system.h:114
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::ExplicitSystem::sys_type
ExplicitSystem sys_type
The type of system.
Definition: explicit_system.h:63
libMesh::ExplicitSystem::system_type
virtual std::string system_type() const override
Definition: explicit_system.h:107
libMesh::ExplicitSystem::add_system_rhs
void add_system_rhs()
Add the system right-hand-side vector to the _vectors data structure.
Definition: explicit_system.C:96
libMesh::System::number
unsigned int number() const
Definition: system.h:2075
libMesh::NumericVector< Number >
libMesh::ExplicitSystem::ExplicitSystem
ExplicitSystem(EquationSystems &es, const std::string &name, const unsigned int number)
Constructor.
Definition: explicit_system.C:32
libMesh::QoISet
Data structure for specifying which Quantities of Interest should be calculated in an adjoint or a pa...
Definition: qoi_set.h:45
libMesh::ExplicitSystem::system
sys_type & system()
Definition: explicit_system.h:73
libMesh::ExplicitSystem::assemble_qoi
virtual void assemble_qoi(const QoISet &qoi_indices=QoISet()) override
Prepares qoi for quantity of interest assembly, then calls user qoi function.
Definition: explicit_system.C:56
libMesh::EquationSystems
This is the EquationSystems class.
Definition: equation_systems.h:74
libMesh::ExplicitSystem
Manages consistently variables, degrees of freedom, and coefficient vectors for explicit systems.
Definition: explicit_system.h:48
libMesh::ExplicitSystem::Parent
System Parent
The type of the parent.
Definition: explicit_system.h:68
libMesh::System::name
const std::string & name() const
Definition: system.h:2067
libMesh::ExplicitSystem::clear
virtual void clear() override
Clear all the data structures associated with the system.
Definition: explicit_system.C:45
libMesh::ExplicitSystem::assemble_qoi_derivative
virtual void assemble_qoi_derivative(const QoISet &qoi_indices=QoISet(), bool include_liftfunc=true, bool apply_constraints=true) override
Prepares adjoint_rhs for quantity of interest derivative assembly, then calls user qoi derivative fun...
Definition: explicit_system.C:69