ComputeBoundaryInitialConditionThread Class Reference

#include <ComputeBoundaryInitialConditionThread.h>

Inheritance diagram for ComputeBoundaryInitialConditionThread:

Public Member Functions
	ComputeBoundaryInitialConditionThread (FEProblemBase &fe_problem)
	ComputeBoundaryInitialConditionThread (ComputeBoundaryInitialConditionThread &x, Threads::split split)
void	onNode (ConstBndNodeRange::const_iterator &nd)
void	join (const ComputeBoundaryInitialConditionThread &)
void	operator() (const ConstBndNodeRange &range)
virtual void	pre ()
	Called before the node range loop.
virtual void	post ()
	Called after the node range loop.
virtual void	onNode (ConstBndNodeRange::const_iterator &node_it)
	Called for each node.
virtual void	postNode (ConstBndNodeRange::const_iterator &node_it)
	Called after the node assembly is done (including surface assembling)
virtual void	caughtMooseException (MooseException &e)
	Called if a MooseException is caught anywhere during the computation.
virtual bool	keepGoing ()
	Whether or not the loop should continue.

Protected Member Functions
virtual void	printGeneralExecutionInformation () const
	Print information about the loop, mostly order of execution of objects.

Protected Attributes
FEProblemBase &	_fe_problem
THREAD_ID	_tid

Private Member Functions
	ComputeBoundaryInitialConditionThread (FEProblemBase &fe_problem, const std::set< VariableName > *target_vars)
	Set IC on specific variables.

Private Attributes
const std::set< VariableName > *	_target_vars = nullptr
	the names of target variables for which the initial conditions are applied

Friends
class	FEProblemBase

Detailed Description

Definition at line 20 of file ComputeBoundaryInitialConditionThread.h.

Constructor & Destructor Documentation

ComputeBoundaryInitialConditionThread() [1/3]

ComputeBoundaryInitialConditionThread::ComputeBoundaryInitialConditionThread

(

FEProblemBase &

fe_problem

)

Definition at line 18 of file ComputeBoundaryInitialConditionThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(fe_problem)
{
}

ComputeBoundaryInitialConditionThread() [2/3]

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

Definition at line 24 of file ComputeBoundaryInitialConditionThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(x, split),
    _target_vars(x._target_vars)
{
}

ComputeBoundaryInitialConditionThread() [3/3]

ComputeBoundaryInitialConditionThread::ComputeBoundaryInitialConditionThread ( FEProblemBase &  fe_problem, const std::set< VariableName > *  target_vars  )

private

Set IC on specific variables.

Definition at line 31 of file ComputeBoundaryInitialConditionThread.C.

  : ThreadedNodeLoop<ConstBndNodeRange, ConstBndNodeRange::const_iterator>(fe_problem),
    _target_vars(target_vars)
{
}

Member Function Documentation

caughtMooseException()

virtual void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::caughtMooseException ( MooseException &  e )

inlinevirtualinherited

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Definition at line 56 of file ThreadedNodeLoop.h.

  {
    Threads::spin_mutex::scoped_lock lock(threaded_node_mutex);
 
    std::string what(e.what());
    _fe_problem.setException(what);
  };

join()

void ComputeBoundaryInitialConditionThread::join

(

const ComputeBoundaryInitialConditionThread &

)

Definition at line 68 of file ComputeBoundaryInitialConditionThread.C.

{
}

keepGoing()

virtual bool ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::keepGoing ( )

inlinevirtualinherited

Whether or not the loop should continue.

Returns

true to keep going, false to stop.

Definition at line 69 of file ThreadedNodeLoop.h.

{ return !_fe_problem.hasException(); }

onNode() [1/2]

void ComputeBoundaryInitialConditionThread::onNode

(

ConstBndNodeRange::const_iterator &

nd

)

Definition at line 39 of file ComputeBoundaryInitialConditionThread.C.

{
  const BndNode * bnode = *nd;
 
  Node * node = bnode->_node;
  BoundaryID boundary_id = bnode->_bnd_id;
 
  for (const auto nl_sys_num : make_range(_fe_problem.numNonlinearSystems()))
    _fe_problem.assembly(_tid, nl_sys_num).reinit(node);
 
  const InitialConditionWarehouse & warehouse = _fe_problem.getInitialConditionWarehouse();
 
  if (warehouse.hasActiveBoundaryObjects(boundary_id, _tid))
  {
    const auto & ics = warehouse.getActiveBoundaryObjects(boundary_id, _tid);
    for (const auto & ic : ics)
    {
      // Skip or include initial conditions based on target variable usage
      const auto & var_name = ic->variable().name();
      if (_target_vars && !_target_vars->count(var_name))
        continue;
 
      if (node->processor_id() == _fe_problem.processor_id())
        ic->computeNodal(*node);
    }
  }
}

onNode() [2/2]

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::onNode ( ConstBndNodeRange::const_iterator &  node_it )

virtualinherited

Called for each node.

Definition at line 43 of file ThreadedNodeLoop.h.

{
}

operator()()

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::operator() ( const ConstBndNodeRange &  range )

inherited

Definition at line 28 of file ThreadedNodeLoop.h.

{
  try
  {
    ParallelUniqueId puid;
    _tid = puid.id;
 
    pre();
    printGeneralExecutionInformation();
 
    for (IteratorType nd = range.begin(); nd != range.end(); ++nd)
    {
      if (!keepGoing())
        break;
 
      onNode(nd);
 
      postNode(nd);
    }
 
    post();
  }
  catch (MooseException & e)
  {
    caughtMooseException(e);
  }
}

post()

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::post ( )

virtualinherited

Called after the node range loop.

Definition at line 38 of file ThreadedNodeLoop.h.

{
}

postNode()

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::postNode ( ConstBndNodeRange::const_iterator &  node_it )

virtualinherited

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

Parameters

node	- active node

Definition at line 50 of file ThreadedNodeLoop.h.

{
}

pre()

void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::pre ( )

virtualinherited

Called before the node range loop.

Reimplemented in ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 33 of file ThreadedNodeLoop.h.

{
}

printGeneralExecutionInformation()

virtual void ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::printGeneralExecutionInformation ( ) const

inlineprotectedvirtualinherited

Print information about the loop, mostly order of execution of objects.

Reimplemented in ComputeNodalAuxBcsThread< AuxKernelType >, ComputeNodalKernelBCJacobiansThread, and ComputeNodalKernelBcsThread.

Definition at line 76 of file ThreadedNodeLoop.h.

{}

Friends And Related Symbol Documentation

FEProblemBase

friend class FEProblemBase

friend

Definition at line 43 of file ComputeBoundaryInitialConditionThread.h.

Member Data Documentation

_fe_problem

FEProblemBase& ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::_fe_problem

protectedinherited

Definition at line 72 of file ThreadedNodeLoop.h.

_target_vars

const std::set<VariableName>* ComputeBoundaryInitialConditionThread::_target_vars = nullptr

private

the names of target variables for which the initial conditions are applied

Definition at line 36 of file ComputeBoundaryInitialConditionThread.h.

Referenced by onNode().

_tid

THREAD_ID ThreadedNodeLoop< ConstBndNodeRange , ConstBndNodeRange::const_iterator >::_tid

protectedinherited

Definition at line 73 of file ThreadedNodeLoop.h.

---

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

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