libMesh
zero_function.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2024 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_ZERO_FUNCTION_H
19 #define LIBMESH_ZERO_FUNCTION_H
20 
21 // Local includes
22 #include "libmesh/const_function.h"
23 
24 // C++ Includes
25 #include <memory>
26 
27 namespace libMesh
28 {
29 
37 template <typename Output=Number>
38 class ZeroFunction : public ConstFunction<Output>
39 {
40 public:
41  ZeroFunction () : ConstFunction<Output>(0) {}
42 
46  ZeroFunction (ZeroFunction &&) = default;
47  ZeroFunction (const ZeroFunction &) = default;
48  ZeroFunction & operator= (const ZeroFunction &) = default;
49  ZeroFunction & operator= (ZeroFunction &&) = default;
50  virtual ~ZeroFunction () = default;
51 
52  virtual std::unique_ptr<FunctionBase<Output>> clone() const override
53  {
54  return std::make_unique<ZeroFunction<Output>>();
55  }
56 };
57 
58 } // namespace libMesh
59 
60 #endif // LIBMESH_ZERO_FUNCTION_H
ConstFunction that simply returns 0.
Definition: zero_function.h:38
virtual ~ZeroFunction()=default
The libMesh namespace provides an interface to certain functionality in the library.
ZeroFunction & operator=(const ZeroFunction &)=default
virtual std::unique_ptr< FunctionBase< Output > > clone() const override
Definition: zero_function.h:52
Function that returns a single value that never changes.