libMesh
const_fem_function.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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 #ifndef LIBMESH_CONST_FEM_FUNCTION_H
19 #define LIBMESH_CONST_FEM_FUNCTION_H
20 
21 #include <string>
22 
23 #include "libmesh/dense_vector.h"
24 #include "libmesh/fem_function_base.h"
25 
26 namespace libMesh
27 {
28 
29 // Forward declarations
30 class Point;
31 
40 template <typename Output=Number>
41 class ConstFEMFunction : public FEMFunctionBase<Output>
42 {
43 public:
44  ConstFEMFunction (const Output c) : _c(c) {}
45 
47 
49  {return UniquePtr<FEMFunctionBase<Output>>( new ConstFEMFunction(*this) ); }
50 
51  virtual Output operator() (const FEMContext &,
52  const Point &,
53  const Real /* time */ = 0.)
54  { return _c; }
55 
56  virtual void operator() (const FEMContext &,
57  const Point &,
58  const Real,
59  DenseVector<Output> & output)
60  {
61  for (std::size_t i = 0; i < output.size(); i++)
62  output(i) = _c;
63  }
64 
65 private:
66  Output _c;
67 };
68 
69 } // namespace libMesh;
70 
71 
72 #endif // LIBMESH_CONST_FEM_FUNCTION_H
virtual Output operator()(const FEMContext &, const Point &, const Real=0.)
ConstFEMFunction(const Output c)
The libMesh namespace provides an interface to certain functionality in the library.
virtual unsigned int size() const libmesh_override
Definition: dense_vector.h:87
std::unique_ptr< T > UniquePtr
Definition: auto_ptr.h:46
virtual UniquePtr< FEMFunctionBase< Output > > clone() const
This class provides all data required for a physics package (e.g.
Definition: fem_context.h:61
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
FEMFunction that returns a single value, regardless of the time and location inputs.
Defines a dense vector for use in Finite Element-type computations.
FEMFunctionBase is a base class from which users can derive in order to define "function-like" object...
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:38