Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2025 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             : #ifndef LIBMESH_CONST_FUNCTION_H
      20             : #define LIBMESH_CONST_FUNCTION_H
      21             : 
      22             : // Local includes
      23             : #include "libmesh/dense_vector.h"
      24             : #include "libmesh/function_base.h"
      25             : #include "libmesh/point.h"
      26             : 
      27             : // C++ includes
      28             : #include <memory>
      29             : #include <string>
      30             : 
      31             : namespace libMesh
      32             : {
      33             : 
      34             : /**
      35             :  * Function that returns a single value that never changes. All
      36             :  * overridden virtual functions are documented in function_base.h.
      37             :  *
      38             :  * \author Roy Stogner
      39             :  * \date 2012
      40             :  * \brief Function that returns a single value that never changes.
      41             :  */
      42             : template <typename Output=Number>
      43             : class ConstFunction : public FunctionBase<Output>
      44             : {
      45             : public:
      46             :   explicit
      47        1566 :   ConstFunction (const Output & c) : _c(c)
      48             :   {
      49        2670 :     this->_initialized = true;
      50        1566 :     this->_is_time_dependent = false;
      51          48 :   }
      52             : 
      53             :   /**
      54             :    * The 5 special functions can be defaulted for this class.
      55             :    */
      56             :   ConstFunction (ConstFunction &&) = default;
      57             :   ConstFunction (const ConstFunction &) = default;
      58             :   ConstFunction & operator= (const ConstFunction &) = default;
      59             :   ConstFunction & operator= (ConstFunction &&) = default;
      60          48 :   virtual ~ConstFunction () = default;
      61             : 
      62           0 :   virtual Output operator() (const Point &,
      63             :                              const Real = 0) override
      64           0 :   { return _c; }
      65             : 
      66       20396 :   virtual void operator() (const Point &,
      67             :                            const Real,
      68             :                            DenseVector<Output> & output) override
      69             :   {
      70        1724 :     unsigned int size = output.size();
      71       47272 :     for (unsigned int i=0; i != size; ++i)
      72       29140 :       output(i) = _c;
      73       20396 :   }
      74             : 
      75           0 :   virtual std::unique_ptr<FunctionBase<Output>> clone() const override
      76             :   {
      77           0 :     return std::make_unique<ConstFunction<Output>>(_c);
      78             :   }
      79             : 
      80             : private:
      81             :   Output _c;
      82             : };
      83             : 
      84             : } // namespace libMesh
      85             : 
      86             : #endif // LIBMESH_CONST_FUNCTION_H