FlagElementsThread Class Reference

#include <FlagElementsThread.h>

Inheritance diagram for FlagElementsThread:

Public Member Functions
	FlagElementsThread (FEProblemBase &fe_problem, std::vector< Number > &serialized_solution, unsigned int max_h_level, const std::string &marker_name)
	FlagElementsThread (FlagElementsThread &x, Threads::split split)
virtual void	onElement (const Elem *elem) override
	Assembly of the element (not including surface assembly) More...
void	join (const FlagElementsThread &)
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
FEProblemBase &	_fe_problem
std::shared_ptr< DisplacedProblem >	_displaced_problem
AuxiliarySystem &	_aux_sys
unsigned int	_system_number
Adaptivity &	_adaptivity
MooseVariableFEBase &	_field_var
unsigned int	_field_var_number
std::vector< Number > &	_serialized_solution
unsigned int	_max_h_level
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 21 of file FlagElementsThread.h.

Constructor & Destructor Documentation

FlagElementsThread() [1/2]

FlagElementsThread::FlagElementsThread	(	FEProblemBase &	fe_problem,
		std::vector< Number > &	serialized_solution,
		unsigned int	max_h_level,
		const std::string &	marker_name
	)

Definition at line 25 of file FlagElementsThread.C.

  : ThreadedElementLoop<ConstElemRange>(fe_problem),
    _fe_problem(fe_problem),
    _displaced_problem(_fe_problem.getDisplacedProblem()),
    _aux_sys(fe_problem.getAuxiliarySystem()),
    _system_number(_aux_sys.number()),
    _adaptivity(_fe_problem.adaptivity()),
    _field_var(_fe_problem.getVariable(
        0, marker_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY)),
    _field_var_number(_field_var.number()),
    _serialized_solution(serialized_solution),
    _max_h_level(max_h_level)
{
}

FlagElementsThread() [2/2]

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

Definition at line 44 of file FlagElementsThread.C.

  : ThreadedElementLoop<ConstElemRange>(x, split),
    _fe_problem(x._fe_problem),
    _displaced_problem(x._displaced_problem),
    _aux_sys(x._aux_sys),
    _system_number(x._system_number),
    _adaptivity(x._adaptivity),
    _field_var(x._field_var),
    _field_var_number(x._field_var_number),
    _serialized_solution(x._serialized_solution),
    _max_h_level(x._max_h_level)
{
}

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 77 of file ThreadedElementLoop.h.

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

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

join()

void FlagElementsThread::join

(

const FlagElementsThread &

)

Definition at line 94 of file FlagElementsThread.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 45 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 101 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 274 of file ThreadedElementLoopBase.h.

{
}

onElement()

void FlagElementsThread::onElement ( const Elem *  elem )

overridevirtual

Assembly of the element (not including surface assembly)

Parameters

elem	- active element

Reimplemented from ThreadedElementLoopBase< ConstElemRange >.

Definition at line 59 of file FlagElementsThread.C.

{
  // By default do nothing, and only grab the marker from the solution if the current variable is
  // active
  // on the element subdomain.
  Marker::MarkerValue marker_value = Marker::DO_NOTHING;
  if (_field_var.activeOnSubdomain(elem->subdomain_id()))
  {
    dof_id_type dof_number = elem->dof_number(_system_number, _field_var_number, 0);

    // round() is a C99 function, it is not located in the std:: namespace.
    marker_value = static_cast<Marker::MarkerValue>(round(_serialized_solution[dof_number]));

    // Make sure we aren't masking an issue in the Marker system by rounding its values.
    if (std::abs(marker_value - _serialized_solution[dof_number]) > TOLERANCE * TOLERANCE)
      mooseError("Invalid Marker value detected: ", _serialized_solution[dof_number]);
  }

  // If no Markers cared about what happened to this element let's just leave it alone
  if (marker_value == Marker::DONT_MARK)
    marker_value = Marker::DO_NOTHING;

  // Don't refine past the max level
  if (_max_h_level && marker_value == Marker::REFINE && elem->level() >= _max_h_level)
    marker_value = Marker::DO_NOTHING;

  const_cast<Elem *>(elem)->set_refinement_flag((Elem::RefinementState)marker_value);

  if (_displaced_problem)
    _displaced_problem->mesh()
        .elemPtr(elem->id())
        ->set_refinement_flag((Elem::RefinementState)marker_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 ComputeResidualThread, and ComputeJacobianThread.

Definition at line 300 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 294 of file ThreadedElementLoopBase.h.

{
}

operator()()

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

inherited

Definition at line 171 of file ThreadedElementLoopBase.h.

{
  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 (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

void ThreadedElementLoopBase< ConstElemRange >::post ( )

virtualinherited

Called after the element range loop.

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

Definition at line 250 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 268 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 288 of file ThreadedElementLoopBase.h.

{
}

pre()

void ThreadedElementLoopBase< ConstElemRange >::pre ( )

virtualinherited

Called before the element range loop.

Definition at line 244 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 87 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 94 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, ComputeJacobianThread, ComputeElemAuxVarsThread, and ComputeMarkerThread.

Definition at line 308 of file ThreadedElementLoopBase.h.

{
}

Member Data Documentation

_adaptivity

Adaptivity& FlagElementsThread::_adaptivity

protected

Definition at line 41 of file FlagElementsThread.h.

_aux_sys

AuxiliarySystem& FlagElementsThread::_aux_sys

protected

Definition at line 39 of file FlagElementsThread.h.

_displaced_problem

std::shared_ptr<DisplacedProblem> FlagElementsThread::_displaced_problem

protected

Definition at line 38 of file FlagElementsThread.h.

Referenced by onElement().

_fe_problem

FEProblemBase& FlagElementsThread::_fe_problem

protected

Definition at line 37 of file FlagElementsThread.h.

_field_var

MooseVariableFEBase& FlagElementsThread::_field_var

protected

Definition at line 42 of file FlagElementsThread.h.

Referenced by onElement().

_field_var_number

unsigned int FlagElementsThread::_field_var_number

protected

Definition at line 43 of file FlagElementsThread.h.

Referenced by onElement().

_max_h_level

unsigned int FlagElementsThread::_max_h_level

protected

Definition at line 45 of file FlagElementsThread.h.

Referenced by onElement().

_mesh

MooseMesh& ThreadedElementLoopBase< ConstElemRange >::_mesh

protectedinherited

Definition at line 136 of file ThreadedElementLoopBase.h.

_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_neighbor_subdomain

protectedinherited

The subdomain for the current neighbor.

Definition at line 146 of file ThreadedElementLoopBase.h.

_old_neighbor_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_neighbor_subdomain

protectedinherited

The subdomain for the last neighbor.

Definition at line 149 of file ThreadedElementLoopBase.h.

_old_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_old_subdomain

protectedinherited

The subdomain for the last element.

Definition at line 143 of file ThreadedElementLoopBase.h.

_serialized_solution

std::vector<Number>& FlagElementsThread::_serialized_solution

protected

Definition at line 44 of file FlagElementsThread.h.

Referenced by onElement().

_subdomain

SubdomainID ThreadedElementLoopBase< ConstElemRange >::_subdomain

protectedinherited

The subdomain for the current element.

Definition at line 140 of file ThreadedElementLoopBase.h.

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

_system_number

unsigned int FlagElementsThread::_system_number

protected

Definition at line 40 of file FlagElementsThread.h.

Referenced by onElement().

_tid

THREAD_ID ThreadedElementLoopBase< ConstElemRange >::_tid

protectedinherited

Definition at line 137 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(), ComputeElemAuxVarsThread::onElement(), ComputeJacobianThread::onElement(), ComputeIndicatorThread::onElement(), ComputeResidualThread::onElement(), ComputeMaterialsObjectThread::onElement(), ComputeUserObjectsThread::onElement(), ComputeJacobianThread::onInterface(), ComputeResidualThread::onInterface(), ComputeJacobianThread::onInternalSide(), ComputeIndicatorThread::onInternalSide(), ComputeResidualThread::onInternalSide(), ComputeMaterialsObjectThread::onInternalSide(), ComputeUserObjectsThread::onInternalSide(), ComputeMarkerThread::post(), ComputeElemAuxVarsThread::post(), ComputeMaterialsObjectThread::post(), ComputeIndicatorThread::post(), ComputeJacobianThread::post(), ComputeResidualThread::post(), ComputeUserObjectsThread::post(), ComputeJacobianThread::postElement(), ComputeResidualThread::postElement(), ComputeJacobianBlocksThread::postElement(), ComputeUserObjectsThread::queryBoundary(), ComputeUserObjectsThread::querySubdomain(), ComputeMarkerThread::subdomainChanged(), ComputeElemAuxVarsThread::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/FlagElementsThread.h
• src/loops/FlagElementsThread.C