Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : #include "SpatialUserObjectFunctor.h"
      13             : #include "LayeredBase.h"
      14             : #include "InputParameters.h"
      15             : 
      16             : /**
      17             :  * Base class for computing layered side integrals
      18             :  */
      19             : template <typename UserObjectType>
      20             : class LayeredIntegralBase : public SpatialUserObjectFunctor<UserObjectType>, public LayeredBase
      21             : {
      22             : public:
      23             :   static InputParameters validParams();
      24             : 
      25             :   LayeredIntegralBase(const InputParameters & parameters);
      26             : 
      27             :   /**
      28             :    * Given a Point return the integral value associated with the layer that point falls in.
      29             :    *
      30             :    * @param p The point to look for in the layers.
      31             :    */
      32     3207107 :   virtual Real spatialValue(const Point & p) const override { return integralValue(p); }
      33             : 
      34             :   virtual const std::vector<Point> spatialPoints() const override;
      35             : 
      36             :   virtual void initialize() override;
      37             :   virtual void execute() override;
      38             :   virtual void finalize() override;
      39             :   virtual void threadJoin(const UserObject & y) override;
      40             : 
      41             : protected:
      42             :   using UserObjectType::_current_elem;
      43             :   using UserObjectType::computeIntegral;
      44             : };
      45             : 
      46             : template <typename UserObjectType>
      47             : InputParameters
      48      280608 : LayeredIntegralBase<UserObjectType>::validParams()
      49             : {
      50      280608 :   InputParameters params = SpatialUserObjectFunctor<UserObjectType>::validParams();
      51      280608 :   params += LayeredBase::validParams();
      52      280608 :   return params;
      53           0 : }
      54             : 
      55             : template <typename UserObjectType>
      56        4683 : LayeredIntegralBase<UserObjectType>::LayeredIntegralBase(const InputParameters & parameters)
      57        4683 :   : SpatialUserObjectFunctor<UserObjectType>(parameters), LayeredBase(parameters)
      58             : {
      59        4659 :   if (parameters.isParamValid("block") && parameters.isParamValid("boundary"))
      60           4 :     mooseError("Both block and boundary cannot be specified for a layered integral user object. If "
      61             :                "you want to define the geometric bounds of the layers from a specified block set "
      62             :                "layer_bounding_block instead.");
      63        4655 : }
      64             : 
      65             : template <typename UserObjectType>
      66             : void
      67        9713 : LayeredIntegralBase<UserObjectType>::initialize()
      68             : {
      69        9713 :   UserObjectType::initialize();
      70        9713 :   LayeredBase::initialize();
      71        9713 : }
      72             : 
      73             : template <typename UserObjectType>
      74             : void
      75      660942 : LayeredIntegralBase<UserObjectType>::execute()
      76             : {
      77      660942 :   const auto integral_value = computeIntegral();
      78             : 
      79      660942 :   const auto layer = getLayer(_current_elem->vertex_average());
      80             : 
      81      660942 :   setLayerValue(layer, getLayerValue(layer) + integral_value);
      82      660942 : }
      83             : 
      84             : template <typename UserObjectType>
      85             : void
      86        8909 : LayeredIntegralBase<UserObjectType>::finalize()
      87             : {
      88        8909 :   LayeredBase::finalize();
      89        8909 : }
      90             : 
      91             : template <typename UserObjectType>
      92             : void
      93         804 : LayeredIntegralBase<UserObjectType>::threadJoin(const UserObject & y)
      94             : {
      95         804 :   UserObjectType::threadJoin(y);
      96         804 :   LayeredBase::threadJoin(y);
      97         804 : }
      98             : 
      99             : template <typename UserObjectType>
     100             : const std::vector<Point>
     101          96 : LayeredIntegralBase<UserObjectType>::spatialPoints() const
     102             : {
     103          96 :   std::vector<Point> points;
     104             : 
     105         360 :   for (const auto & l : _layer_centers)
     106             :   {
     107         264 :     Point pt(0.0, 0.0, 0.0);
     108         264 :     pt(_direction) = l;
     109         264 :     points.push_back(pt);
     110             :   }
     111             : 
     112          96 :   return points;
     113           0 : }