ElementLoopUserObject.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "GeneralUserObject.h"
#include "Coupleable.h"
#include "ScalarCoupleable.h"
#include "MooseVariableDependencyInterface.h"
#include "MooseVariable.h"
#include "SubProblem.h"
#include "NonlinearSystem.h"
#include "Assembly.h"
#include "FEProblem.h"
#include "MooseMesh.h"
 
#include "libmesh/elem.h"
#include "libmesh/parallel_algebra.h"
 
// Forward Declarations
 
namespace libMesh
{
class Elem;
class QBase;
}
 
class ElementLoopUserObject : public GeneralUserObject,
                              public BlockRestrictable,
                              public Coupleable,
                              public MooseVariableDependencyInterface
{
public:
  static InputParameters validParams();
 
  ElementLoopUserObject(const InputParameters & parameters);
  ElementLoopUserObject(ElementLoopUserObject & x, Threads::split split);
  virtual ~ElementLoopUserObject();
 
  virtual void initialize();
  virtual void execute();
  virtual void finalize();
 
  virtual void pre();
  virtual void preElement(const Elem * elem);
  virtual void onElement(const Elem * elem);
  virtual void onBoundary(const Elem * elem, unsigned int side, BoundaryID bnd_id);
  virtual void onInternalSide(const Elem * elem, unsigned int side);
  virtual void onInterface(const Elem * elem, unsigned int side, BoundaryID bnd_id);
  virtual void post();
  virtual void subdomainChanged();
  virtual bool keepGoing() { return true; }
 
  virtual void meshChanged();
 
  void join(const ElementLoopUserObject & /*y*/);
 
protected:
  virtual void caughtMooseException(MooseException & e);
 
  MooseMesh & _mesh;
 
  const Elem * _current_elem;
  const Real & _current_elem_volume;
  unsigned int _current_side;
  const Elem * _current_neighbor;
 
  const MooseArray<Point> & _q_point;
  const QBase * const & _qrule;
  const MooseArray<Real> & _JxW;
  const MooseArray<Real> & _coord;
 
  bool _have_interface_elems;
  std::set<dof_id_type> _interface_elem_ids;
 
  SubdomainID _subdomain;
 
  SubdomainID _old_subdomain;
 
  virtual void computeElement();
  virtual void computeBoundary();
  virtual void computeInternalSide();
  virtual void computeInterface();
};