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             : 
      20             : #ifndef LIBMESH_DISCONTINUITY_MEASURE_H
      21             : #define LIBMESH_DISCONTINUITY_MEASURE_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/jump_error_estimator.h"
      25             : 
      26             : // C++ includes
      27             : #include <cstddef>
      28             : #include <string>
      29             : #include <vector>
      30             : 
      31             : namespace libMesh
      32             : {
      33             : 
      34             : // Forward Declarations
      35             : class Point;
      36             : 
      37             : 
      38             : 
      39             : 
      40             : 
      41             : /**
      42             :  * This class measures discontinuities between elements
      43             :  * for debugging purposes.  It derives from ErrorEstimator
      44             :  * just in case someone finds it useful in a DG framework.
      45             :  *
      46             :  * \author Roy H. Stogner
      47             :  * \date 2006
      48             :  */
      49             : class DiscontinuityMeasure : public JumpErrorEstimator
      50             : {
      51             : public:
      52             : 
      53             :   /**
      54             :    * Constructor.  Responsible for initializing the _bc_function function
      55             :    * pointer to nullptr.  Defaults to L2 norm; changes to system norm are
      56             :    * ignored.
      57             :    */
      58             :   DiscontinuityMeasure();
      59             : 
      60             :   /**
      61             :    * This class cannot be (default) copy constructed/assigned because
      62             :    * its base class has unique_ptr members.
      63             :    */
      64             :   DiscontinuityMeasure (const DiscontinuityMeasure &) = delete;
      65             :   DiscontinuityMeasure & operator= (const DiscontinuityMeasure &) = delete;
      66             : 
      67             :   /**
      68             :    * Defaulted move ctor, move assignment operator, and destructor.
      69             :    */
      70             :   DiscontinuityMeasure (DiscontinuityMeasure &&) = default;
      71             :   DiscontinuityMeasure & operator= (DiscontinuityMeasure &&) = default;
      72           0 :   virtual ~DiscontinuityMeasure() = default;
      73             : 
      74             :   /**
      75             :    * Register a user function to use in computing the essential BCs.
      76             :    */
      77             :   void attach_essential_bc_function (std::pair<bool,Real> fptr(const System & system,
      78             :                                                                const Point & p,
      79             :                                                                const std::string & var_name));
      80             : 
      81             :   virtual ErrorEstimatorType type() const override;
      82             : 
      83             : protected:
      84             : 
      85             :   /**
      86             :    * An initialization function, for requesting specific data from the FE
      87             :    * objects
      88             :    */
      89             :   virtual void init_context(FEMContext & c) override;
      90             : 
      91             :   /**
      92             :    * The function which calculates a normal derivative jump based error
      93             :    * term on an internal side
      94             :    */
      95             :   virtual void internal_side_integration() override;
      96             : 
      97             :   /**
      98             :    * The function which calculates a normal derivative jump based error
      99             :    * term on a boundary side.
     100             :    *
     101             :    * \returns \p true if the flux bc function is in fact defined on the current side.
     102             :    */
     103             :   virtual bool boundary_side_integration() override;
     104             : 
     105             :   /**
     106             :    * Pointer to function that provides BC information.
     107             :    */
     108             :   std::pair<bool,Real> (* _bc_function) (const System & system,
     109             :                                          const Point & p,
     110             :                                          const std::string & var_name);
     111             : };
     112             : 
     113             : 
     114             : } // namespace libMesh
     115             : 
     116             : #endif // LIBMESH_DISCONTINUITY_MEASURE_H