UpdateErrorVectorsThread Class Reference

#include <UpdateErrorVectorsThread.h>

Inheritance diagram for UpdateErrorVectorsThread:

Public Member Functions
	UpdateErrorVectorsThread (FEProblemBase &fe_problem, const std::map< std::string, std::unique_ptr< ErrorVector >> &indicator_field_to_error_vector)
	UpdateErrorVectorsThread (UpdateErrorVectorsThread &x, Threads::split split)
virtual void	onElement (const Elem *elem) override
	Assembly of the element (not including surface assembly) More...
void	join (const UpdateErrorVectorsThread &)
virtual void	caughtMooseException (MooseException &e) override
	Called if a MooseException is caught anywhere during the computation. More...
virtual bool	keepGoing () override
	Whether or not the loop should continue. More...
virtual void	preElement (const Elem *elem) override
	Called before the element assembly. More...
virtual void	preInternalSide (const Elem *elem, unsigned int side) override
	Called before evaluations on an element internal side. More...
virtual void	neighborSubdomainChanged () override
	Called every time the neighbor subdomain changes (i.e. More...
void	operator() (const ConstElemRange &range, bool bypass_threading=false)
virtual void	pre ()
	Called before the element range loop. More...
virtual void	post ()
	Called after the element range loop. More...
virtual void	postElement (const Elem *elem)
	Called after the element assembly is done (including surface assembling) More...
virtual void	onBoundary (const Elem *elem, unsigned int side, BoundaryID bnd_id)
	Called when doing boundary assembling. More...
virtual void	postInternalSide (const Elem *elem, unsigned int side)
	Called after evaluations on an element internal side. More...
virtual void	onInternalSide (const Elem *elem, unsigned int side)
	Called when doing internal edge assembling. More...
virtual void	onInterface (const Elem *elem, unsigned int side, BoundaryID bnd_id)
	Called when doing interface assembling. More...
virtual void	subdomainChanged ()
	Called every time the current subdomain changes (i.e. More...

Protected Attributes
const std::map< std::string, std::unique_ptr< ErrorVector > > &	_indicator_field_to_error_vector
AuxiliarySystem &	_aux_sys
unsigned int	_system_number
Adaptivity &	_adaptivity
NumericVector< Number > &	_solution
std::map< unsigned int, ErrorVector * >	_indicator_field_number_to_error_vector
FEProblemBase &	_fe_problem
MooseMesh &	_mesh
THREAD_ID	_tid
SubdomainID	_subdomain
	The subdomain for the current element. More...
SubdomainID	_old_subdomain
	The subdomain for the last element. More...
SubdomainID	_neighbor_subdomain
	The subdomain for the current neighbor. More...
SubdomainID	_old_neighbor_subdomain
	The subdomain for the last neighbor. More...

Detailed Description

Definition at line 20 of file UpdateErrorVectorsThread.h.

Constructor & Destructor Documentation

UpdateErrorVectorsThread() [1/2]

UpdateErrorVectorsThread::UpdateErrorVectorsThread	(	FEProblemBase &	fe_problem,
		const std::map< std::string, std::unique_ptr< ErrorVector >> &	indicator_field_to_error_vector
	)

Definition at line 22 of file UpdateErrorVectorsThread.C.

  : ThreadedElementLoop<ConstElemRange>(fe_problem),
    _indicator_field_to_error_vector(indicator_field_to_error_vector),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _system_number(_aux_sys.number()),
    _adaptivity(fe_problem.adaptivity()),
    _solution(_aux_sys.solution())
{
  // Build up this map once so we don't have to do these lookups over and over again
  for (const auto & it : _indicator_field_to_error_vector)
  {
    unsigned int var_num = _aux_sys.getVariable(0, it.first).number();
    _indicator_field_number_to_error_vector.emplace(var_num, it.second.get());
  }
}

UpdateErrorVectorsThread() [2/2]

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

Definition at line 41 of file UpdateErrorVectorsThread.C.

  : ThreadedElementLoop<ConstElemRange>(x, split),
    _indicator_field_to_error_vector(x._indicator_field_to_error_vector),
    _aux_sys(x._aux_sys),
    _system_number(x._system_number),
    _adaptivity(x._adaptivity),
    _solution(x._solution),
    _indicator_field_number_to_error_vector(x._indicator_field_number_to_error_vector)
{
}

Member Function Documentation

caughtMooseException()

void ThreadedElementLoop< ConstElemRange >::caughtMooseException ( MooseException &  e )

overridevirtualinherited

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 76 of file ThreadedElementLoop.h.

{
  Threads::spin_mutex::scoped_lock lock(threaded_element_mutex);

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

join()

void UpdateErrorVectorsThread::join

(

const UpdateErrorVectorsThread &

)

Definition at line 68 of file UpdateErrorVectorsThread.C.

{
}

keepGoing()

virtual bool ThreadedElementLoop< ConstElemRange >::keepGoing ( )

inlineoverridevirtualinherited

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 44 of file ThreadedElementLoop.h.

{ return !_fe_problem.hasException(); }

neighborSubdomainChanged()

void ThreadedElementLoop< ConstElemRange >::neighborSubdomainChanged ( )

overridevirtualinherited

Called every time the neighbor subdomain changes (i.e.

the subdomain of this neighbor is not the same as the subdomain of the last neighbor). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 100 of file ThreadedElementLoop.h.

{
  _fe_problem.neighborSubdomainSetup(ThreadedElementLoopBase<RangeType>::_neighbor_subdomain,
                                     ThreadedElementLoopBase<RangeType>::_tid);
}

onBoundary()

void ThreadedElementLoopBase< ConstElemRange >::onBoundary ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

virtualinherited

Called when doing boundary assembling.

Parameters

elem	- The element we are checking is on the boundary.
side	- The side of the element in question.
bnd_id	- ID of the boundary we are at

Reimplemented in ComputeUserObjectsThread, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 283 of file ThreadedElementLoopBase.h.

{
}

onElement()

void UpdateErrorVectorsThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 54 of file UpdateErrorVectorsThread.C.

{
  for (const auto & it : _indicator_field_number_to_error_vector)
  {
    unsigned int var_num = it.first;
    ErrorVector & ev = *(it.second);

    dof_id_type dof_number = elem->dof_number(_system_number, var_num, 0);
    Real value = _solution(dof_number);
    ev[elem->id()] = value;
  }
}

onInterface()

void ThreadedElementLoopBase< ConstElemRange >::onInterface ( const Elem *  elem, unsigned int  side, BoundaryID  bnd_id  )

virtualinherited

Called when doing interface assembling.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'
bnd_id	- ID of the interface we are at

Reimplemented in ComputeUserObjectsThread, ComputeResidualThread, and ComputeJacobianThread.

Definition at line 309 of file ThreadedElementLoopBase.h.

{
}

onInternalSide()

void ThreadedElementLoopBase< ConstElemRange >::onInternalSide ( const Elem *  elem, unsigned int  side  )

virtualinherited

Called when doing internal edge assembling.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Reimplemented in ComputeUserObjectsThread, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 303 of file ThreadedElementLoopBase.h.

{
}

operator()()

void ThreadedElementLoopBase< ConstElemRange >::operator() ( const ConstElemRange &  range, bool  bypass_threading = false  )

inherited

Definition at line 173 of file ThreadedElementLoopBase.h.

{
  try
  {
    try
    {
      ParallelUniqueId puid;
      _tid = bypass_threading ? 0 : puid.id;

      pre();

      _subdomain = Moose::INVALID_BLOCK_ID;
      _neighbor_subdomain = Moose::INVALID_BLOCK_ID;
      typename RangeType::const_iterator el = range.begin();
      for (el = range.begin(); el != range.end(); ++el)
      {
        if (!keepGoing())
          break;

        const Elem * elem = *el;

        preElement(elem);

        _old_subdomain = _subdomain;
        _subdomain = elem->subdomain_id();
        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);

          const Elem * neighbor = elem->neighbor_ptr(side);
          if (neighbor != nullptr)
          {
            preInternalSide(elem, side);

            _old_neighbor_subdomain = _neighbor_subdomain;
            _neighbor_subdomain = neighbor->subdomain_id();
            if (_neighbor_subdomain != _old_neighbor_subdomain)
              neighborSubdomainChanged();

            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);

            postInternalSide(elem, side);
          }
        } // sides
        postElement(elem);

      } // range

      post();
    }
    catch (libMesh::LogicError & e)
    {
      throw MooseException("We caught a libMesh error");
    }
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

void ThreadedElementLoopBase< ConstElemRange >::post ( )

virtualinherited

Called after the element range loop.

Reimplemented in ComputeUserObjectsThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, ComputeMaterialsObjectThread, ComputeElemAuxVarsThread< AuxKernelType >, and ComputeMarkerThread.

Definition at line 259 of file ThreadedElementLoopBase.h.

{
}

postElement()

void ThreadedElementLoopBase< ConstElemRange >::postElement ( const Elem *  elem )

virtualinherited

Called after the element assembly is done (including surface assembling)

Parameters

elem	- active element

Reimplemented in ComputeJacobianBlocksThread, ComputeResidualThread, ComputeIndicatorThread, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 277 of file ThreadedElementLoopBase.h.

{
}

postInternalSide()

void ThreadedElementLoopBase< ConstElemRange >::postInternalSide ( const Elem *  elem, unsigned int  side  )

virtualinherited

Called after evaluations on an element internal side.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Definition at line 297 of file ThreadedElementLoopBase.h.

{
}

pre()

void ThreadedElementLoopBase< ConstElemRange >::pre ( )

virtualinherited

Called before the element range loop.

Definition at line 253 of file ThreadedElementLoopBase.h.

{
}

preElement()

void ThreadedElementLoop< ConstElemRange >::preElement ( const Elem *  elem )

overridevirtualinherited

Called before the element assembly.

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 86 of file ThreadedElementLoop.h.

{
  _fe_problem.setCurrentSubdomainID(el, ThreadedElementLoopBase<RangeType>::_tid);
}

preInternalSide()

void ThreadedElementLoop< ConstElemRange >::preInternalSide ( const Elem *  elem, unsigned int  side  )

overridevirtualinherited

Called before evaluations on an element internal side.

Parameters

elem	- Element we are on
side	- local side number of the element 'elem'

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 93 of file ThreadedElementLoop.h.

{
  _fe_problem.setNeighborSubdomainID(el, side, ThreadedElementLoopBase<RangeType>::_tid);
}

subdomainChanged()

void ThreadedElementLoopBase< ConstElemRange >::subdomainChanged ( )

virtualinherited

Called every time the current subdomain changes (i.e.

the subdomain of this element is not the same as the subdomain of the last element). Beware of over-using this! You might think that you can do some expensive stuff in here and get away with it... but there are applications that have TONS of subdomains....

Reimplemented in ComputeUserObjectsThread, ComputeMaterialsObjectThread, ComputeResidualThread, ComputeIndicatorThread, ComputeElemAuxVarsThread< AuxKernelType >, ComputeJacobianThread, and ComputeMarkerThread.

Definition at line 317 of file ThreadedElementLoopBase.h.

{
}

Member Data Documentation

_adaptivity

Adaptivity& UpdateErrorVectorsThread::_adaptivity

protected

Definition at line 38 of file UpdateErrorVectorsThread.h.

_aux_sys

AuxiliarySystem& UpdateErrorVectorsThread::_aux_sys

protected

Definition at line 36 of file UpdateErrorVectorsThread.h.

Referenced by UpdateErrorVectorsThread().

_fe_problem

FEProblemBase& ThreadedElementLoop< ConstElemRange >::_fe_problem

protectedinherited

Definition at line 53 of file ThreadedElementLoop.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeInternalInterFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeJacobianThread::onBoundary(), ComputeResidualThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), ComputeElemDampingThread::onElement(), ComputeJacobianThread::onElement(), ComputeResidualThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInterface(), ComputeResidualThread::onInterface(), ComputeUserObjectsThread::onInterface(), ComputeJacobianThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), ComputeJacobianThread::post(), ComputeResidualThread::post(), ComputeUserObjectsThread::post(), ComputeJacobianThread::postElement(), ComputeResidualThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeJacobianThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

_indicator_field_number_to_error_vector

std::map<unsigned int, ErrorVector *> UpdateErrorVectorsThread::_indicator_field_number_to_error_vector

protected

Definition at line 41 of file UpdateErrorVectorsThread.h.

Referenced by onElement(), and UpdateErrorVectorsThread().

_indicator_field_to_error_vector

const std::map<std::string, std::unique_ptr<ErrorVector> >& UpdateErrorVectorsThread::_indicator_field_to_error_vector

protected

Definition at line 35 of file UpdateErrorVectorsThread.h.

Referenced by UpdateErrorVectorsThread().

_mesh

MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh

protectedinherited

Definition at line 138 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 148 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 151 of file ThreadedElementLoopBase.h.

_old_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 145 of file ThreadedElementLoopBase.h.

_solution

NumericVector<Number>& UpdateErrorVectorsThread::_solution

protected

Definition at line 39 of file UpdateErrorVectorsThread.h.

Referenced by onElement().

_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 142 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeMaterialsObjectThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), ComputeMarkerThread::onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeResidualThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::querySubdomain(), ComputeMarkerThread::subdomainChanged(), ComputeJacobianThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

_system_number

unsigned int UpdateErrorVectorsThread::_system_number

protected

Definition at line 37 of file UpdateErrorVectorsThread.h.

Referenced by onElement().

_tid

THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid

protectedinherited

Definition at line 139 of file ThreadedElementLoopBase.h.

Referenced by ComputeFullJacobianThread::computeFaceJacobian(), ComputeJacobianThread::computeFaceJacobian(), ComputeFullJacobianThread::computeInternalFaceJacobian(), ComputeJacobianThread::computeInternalFaceJacobian(), ComputeFullJacobianThread::computeInternalInterFaceJacobian(), ComputeJacobianThread::computeInternalInterFaceJacobian(), ComputeFullJacobianThread::computeJacobian(), ComputeJacobianThread::computeJacobian(), ComputeJacobianThread::onBoundary(), ComputeResidualThread::onBoundary(), ComputeMaterialsObjectThread::onBoundary(), ComputeUserObjectsThread::onBoundary(), ComputeMarkerThread::onElement(), ComputeElemDampingThread::onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeResidualThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInterface(), ComputeResidualThread::onInterface(), ComputeUserObjectsThread::onInterface(), ComputeJacobianThread::onInternalSide(), ComputeIndicatorThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), ComputeMarkerThread::post(), ComputeMaterialsObjectThread::post(), ComputeJacobianThread::post(), ComputeIndicatorThread::post(), ComputeResidualThread::post(), ComputeUserObjectsThread::post(), ComputeJacobianThread::postElement(), ComputeResidualThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeUserObjectsThread::queryBoundary(), ComputeUserObjectsThread::querySubdomain(), ComputeMarkerThread::subdomainChanged(), ComputeJacobianThread::subdomainChanged(), ComputeIndicatorThread::subdomainChanged(), ComputeResidualThread::subdomainChanged(), ComputeMaterialsObjectThread::subdomainChanged(), and ComputeUserObjectsThread::subdomainChanged().

---

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

• include/loops/UpdateErrorVectorsThread.h
• src/loops/UpdateErrorVectorsThread.C