ElementLoopUserObject Class Reference

A base class that loops over elements and do things. More...

#include <ElementLoopUserObject.h>

Inheritance diagram for ElementLoopUserObject:

Public Member Functions
	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 ()
virtual void	meshChanged ()
void	join (const ElementLoopUserObject &)

Protected Member Functions
virtual void	caughtMooseException (MooseException &e)
virtual void	computeElement ()
virtual void	computeBoundary ()
virtual void	computeInternalSide ()
virtual void	computeInterface ()

Protected Attributes
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
	true if we have cached interface elements, false if they need to be cached. We want to (re)cache only when mesh changed More...
std::set< dof_id_type >	_interface_elem_ids
	List of element IDs that are on the processor boundary and need to be send to other processors. More...
SubdomainID	_subdomain
	The subdomain for the current element. More...
SubdomainID	_old_subdomain
	The subdomain for the last element. More...

Detailed Description

A base class that loops over elements and do things.

Notes:

1. this class is designed to enable more than one element-loop in the execution of user objects. It is necessary because in many numerical schemes, the data required in one element-loop should be pre-computed from another element-loop.

   For example, in the workflow of a cell-centered finite volume method, two element-loops are required in a specific sequence in user objects:

   First, an element-loop is requried to calculate the in-cell gradients of variables using a piecewise linear reconstruction scheme.

   Second, another element-loop is required to calculate the limited in-cell gradients of variables based on the reconstructed gradients from the element and its face-neighboring elements.

Definition at line 58 of file ElementLoopUserObject.h.

Constructor & Destructor Documentation

ElementLoopUserObject() [1/2]

ElementLoopUserObject::ElementLoopUserObject

(

const InputParameters &

parameters

)

Definition at line 21 of file ElementLoopUserObject.C.

  : GeneralUserObject(parameters),
    BlockRestrictable(this),
    Coupleable(this, false),
    MooseVariableDependencyInterface(),
    _mesh(_subproblem.mesh()),
    _current_elem(_assembly.elem()),
    _current_elem_volume(_assembly.elemVolume()),
    _q_point(_assembly.qPoints()),
    _qrule(_assembly.qRule()),
    _JxW(_assembly.JxW()),
    _coord(_assembly.coordTransformation()),
    _have_interface_elems(false)
{
  // Keep track of which variables are coupled so we know what we depend on
  const std::vector<MooseVariableFEBase *> & coupled_vars = getCoupledMooseVars();
  for (unsigned int i = 0; i < coupled_vars.size(); i++)
    addMooseVariableDependency(coupled_vars[i]);
}

ElementLoopUserObject() [2/2]

ElementLoopUserObject::ElementLoopUserObject	(	ElementLoopUserObject &	x,
		Threads::split	split
	)

Definition at line 41 of file ElementLoopUserObject.C.

  : GeneralUserObject(x.parameters()),
    BlockRestrictable(&x),
    Coupleable(this, false),
    MooseVariableDependencyInterface(),
    _mesh(x._subproblem.mesh()),
    _current_elem(x._assembly.elem()),
    _current_elem_volume(x._assembly.elemVolume()),
    _q_point(x._assembly.qPoints()),
    _qrule(x._assembly.qRule()),
    _JxW(x._assembly.JxW()),
    _coord(x._assembly.coordTransformation()),
    _have_interface_elems(false)
{
  // Keep track of which variables are coupled so we know what we depend on
  const std::vector<MooseVariableFEBase *> & coupled_vars = x.getCoupledMooseVars();
  for (unsigned int i = 0; i < coupled_vars.size(); i++)
    addMooseVariableDependency(coupled_vars[i]);
}

~ElementLoopUserObject()

ElementLoopUserObject::~ElementLoopUserObject ( )

virtual

Definition at line 61 of file ElementLoopUserObject.C.

{}

Member Function Documentation

caughtMooseException()

void ElementLoopUserObject::caughtMooseException ( MooseException &  e )

protectedvirtual

Definition at line 260 of file ElementLoopUserObject.C.

{
  std::string what(e.what());
  _fe_problem.setException(what);
}

Referenced by execute().

computeBoundary()

void ElementLoopUserObject::computeBoundary ( )

protectedvirtual

Definition at line 238 of file ElementLoopUserObject.C.

{
}

Referenced by onBoundary().

computeElement()

void ElementLoopUserObject::computeElement ( )

protectedvirtual

Reimplemented in SlopeReconstructionBase, and SlopeLimitingBase.

Definition at line 233 of file ElementLoopUserObject.C.

{
}

Referenced by onElement().

computeInterface()

void ElementLoopUserObject::computeInterface ( )

protectedvirtual

Definition at line 248 of file ElementLoopUserObject.C.

{
}

Referenced by onInterface().

computeInternalSide()

void ElementLoopUserObject::computeInternalSide ( )

protectedvirtual

Definition at line 243 of file ElementLoopUserObject.C.

{
}

Referenced by onInternalSide().

execute()

void ElementLoopUserObject::execute ( )

virtual

Definition at line 75 of file ElementLoopUserObject.C.

{
  ConstElemRange & elem_range = *_mesh.getActiveLocalElementRange();
 
  try
  {
    pre();
 
    _subdomain = std::numeric_limits<SubdomainID>::max();
    ConstElemRange::const_iterator el = elem_range.begin();
    for (el = elem_range.begin(); el != elem_range.end(); ++el)
    {
      if (!keepGoing())
        break;
 
      const Elem * elem = *el;
      unsigned int cur_subdomain = elem->subdomain_id();
      preElement(elem);
 
      _old_subdomain = _subdomain;
      _subdomain = cur_subdomain;
 
      if (this->hasBlocks(_subdomain))
      {
        if (_subdomain != _old_subdomain)
          subdomainChanged();
 
        onElement(elem);
 
        for (unsigned int side = 0; side < elem->n_sides(); side++)
        {
          std::vector<BoundaryID> boundary_ids = _mesh.getBoundaryIDs(elem, side);
 
          if (boundary_ids.size() > 0)
            for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
                 it != boundary_ids.end();
                 ++it)
              onBoundary(elem, side, *it);
 
          if (elem->neighbor_ptr(side) != NULL)
          {
            if (this->hasBlocks(elem->neighbor_ptr(side)->subdomain_id()))
              onInternalSide(elem, side);
            if (boundary_ids.size() > 0)
              for (std::vector<BoundaryID>::iterator it = boundary_ids.begin();
                   it != boundary_ids.end();
                   ++it)
                onInterface(elem, side, *it);
          }
        } // sides
      }
    } // range
 
    post();
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

finalize()

void ElementLoopUserObject::finalize ( )

virtual

Reimplemented in SlopeReconstructionBase, and SlopeLimitingBase.

Definition at line 137 of file ElementLoopUserObject.C.

{
  _have_interface_elems = true;
}

Referenced by SlopeLimitingBase::finalize(), and SlopeReconstructionBase::finalize().

initialize()

void ElementLoopUserObject::initialize ( )

virtual

Reimplemented in SlopeReconstructionBase, and SlopeLimitingBase.

Definition at line 64 of file ElementLoopUserObject.C.

{
}

Referenced by SlopeLimitingBase::initialize(), and SlopeReconstructionBase::initialize().

join()

void ElementLoopUserObject::join

(

const ElementLoopUserObject &

)

Definition at line 228 of file ElementLoopUserObject.C.

{
}

keepGoing()

virtual bool ElementLoopUserObject::keepGoing ( )

inlinevirtual

Definition at line 80 of file ElementLoopUserObject.h.

{ return true; }

Referenced by execute().

meshChanged()

void ElementLoopUserObject::meshChanged ( )

virtual

Reimplemented in SlopeReconstructionBase.

Definition at line 253 of file ElementLoopUserObject.C.

{
  _interface_elem_ids.clear();
  _have_interface_elems = false;
}

Referenced by SlopeReconstructionBase::meshChanged().

onBoundary()

void ElementLoopUserObject::onBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

virtual

Definition at line 160 of file ElementLoopUserObject.C.

{
  _current_side = side;
  computeBoundary();
}

Referenced by execute().

onElement()

void ElementLoopUserObject::onElement ( const Elem *  elem )

virtual

Definition at line 153 of file ElementLoopUserObject.C.

{
  _current_elem = elem;
  computeElement();
}

Referenced by execute().

onInterface()

void ElementLoopUserObject::onInterface ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

virtual

Definition at line 195 of file ElementLoopUserObject.C.

{
  _current_elem = elem;
  // Pointer to the neighbor we are currently working on.
  _current_neighbor = elem->neighbor_ptr(side);
 
  // Get the global id of the element and the neighbor
  const dof_id_type elem_id = elem->id();
  const dof_id_type neighbor_id = _current_neighbor->id();
 
  // TODO: add if-statement to check if this needs to be executed
  if ((_current_neighbor->active() && (_current_neighbor->level() == elem->level()) &&
       (elem_id < neighbor_id)) ||
      (_current_neighbor->level() < elem->level()))
  {
    computeInterface();
  }
 
  if (!_have_interface_elems &&
      (_current_elem->processor_id() != _current_neighbor->processor_id()))
  {
    // if my current neighbor is on another processor store the current element
    // ID for later communication
    _interface_elem_ids.insert(_current_elem->id());
  }
}

Referenced by execute().

onInternalSide()

void ElementLoopUserObject::onInternalSide ( const Elem *  elem, unsigned int  side  )

virtual

Definition at line 167 of file ElementLoopUserObject.C.

{
  _current_elem = elem;
  // Pointer to the neighbor we are currently working on.
  _current_neighbor = elem->neighbor_ptr(side);
 
  // Get the global id of the element and the neighbor
  const dof_id_type elem_id = elem->id();
  const dof_id_type neighbor_id = _current_neighbor->id();
 
  // TODO: add if-statement to check if this needs to be executed
  if ((_current_neighbor->active() && (_current_neighbor->level() == elem->level()) &&
       (elem_id < neighbor_id)) ||
      (_current_neighbor->level() < elem->level()))
  {
    computeInternalSide();
  }
 
  if (!_have_interface_elems &&
      (_current_elem->processor_id() != _current_neighbor->processor_id()))
  {
    // if my current neighbor is on another processor store the current element ID for later
    // communication
    _interface_elem_ids.insert(_current_elem->id());
  }
}

Referenced by execute().

post()

void ElementLoopUserObject::post ( )

virtual

Definition at line 223 of file ElementLoopUserObject.C.

{
}

Referenced by execute().

pre()

void ElementLoopUserObject::pre ( )

virtual

Definition at line 143 of file ElementLoopUserObject.C.

{
}

Referenced by execute().

preElement()

void ElementLoopUserObject::preElement ( const Elem *  elem )

virtual

Definition at line 69 of file ElementLoopUserObject.C.

{
  _fe_problem.setCurrentSubdomainID(elem, _tid);
}

Referenced by execute().

subdomainChanged()

void ElementLoopUserObject::subdomainChanged ( )

virtual

Definition at line 148 of file ElementLoopUserObject.C.

{
}

Referenced by execute().

Member Data Documentation

_coord

const MooseArray<Real>& ElementLoopUserObject::_coord

protected

Definition at line 99 of file ElementLoopUserObject.h.

_current_elem

const Elem* ElementLoopUserObject::_current_elem

protected

Definition at line 91 of file ElementLoopUserObject.h.

Referenced by SlopeLimitingBase::computeElement(), AEFVSlopeLimitingOneD::limitElementSlope(), onElement(), onInterface(), and onInternalSide().

_current_elem_volume

const Real& ElementLoopUserObject::_current_elem_volume

protected

Definition at line 92 of file ElementLoopUserObject.h.

_current_neighbor

const Elem* ElementLoopUserObject::_current_neighbor

protected

Definition at line 94 of file ElementLoopUserObject.h.

Referenced by onInterface(), and onInternalSide().

_current_side

unsigned int ElementLoopUserObject::_current_side

protected

Definition at line 93 of file ElementLoopUserObject.h.

Referenced by onBoundary().

_have_interface_elems

bool ElementLoopUserObject::_have_interface_elems

protected

true if we have cached interface elements, false if they need to be cached. We want to (re)cache only when mesh changed

Definition at line 102 of file ElementLoopUserObject.h.

Referenced by finalize(), meshChanged(), onInterface(), and onInternalSide().

_interface_elem_ids

std::set<dof_id_type> ElementLoopUserObject::_interface_elem_ids

protected

List of element IDs that are on the processor boundary and need to be send to other processors.

Definition at line 104 of file ElementLoopUserObject.h.

Referenced by meshChanged(), onInterface(), onInternalSide(), SlopeLimitingBase::serialize(), and SlopeReconstructionBase::serialize().

_JxW

const MooseArray<Real>& ElementLoopUserObject::_JxW

protected

Definition at line 98 of file ElementLoopUserObject.h.

_mesh

MooseMesh& ElementLoopUserObject::_mesh

protected

Definition at line 89 of file ElementLoopUserObject.h.

Referenced by execute(), and SlopeReconstructionMultiD::SlopeReconstructionMultiD().

_old_subdomain

SubdomainID ElementLoopUserObject::_old_subdomain

protected

The subdomain for the last element.

Definition at line 110 of file ElementLoopUserObject.h.

Referenced by execute().

_q_point

const MooseArray<Point>& ElementLoopUserObject::_q_point

protected

Definition at line 96 of file ElementLoopUserObject.h.

_qrule

const QBase* const & ElementLoopUserObject::_qrule

protected

Definition at line 97 of file ElementLoopUserObject.h.

_subdomain

SubdomainID ElementLoopUserObject::_subdomain

protected

The subdomain for the current element.

Definition at line 107 of file ElementLoopUserObject.h.

Referenced by execute().

---

The documentation for this class was generated from the following files:

• rdg/include/userobjects/ElementLoopUserObject.h
• rdg/src/userobjects/ElementLoopUserObject.C