Thread to compute threaded general user objects. More...

#include <ComputeThreadedGeneralUserObjectsThread.h>

Public Member Functions
	ComputeThreadedGeneralUserObjectsThread (FEProblemBase &fe_problem)

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

virtual	~ComputeThreadedGeneralUserObjectsThread ()

void	operator() (const GeneralUserObjectRange &range)

void	join (const ComputeThreadedGeneralUserObjectsThread &)

virtual void	caughtMooseException (MooseException &)
	Called if a MooseException is caught anywhere during the computation. More...

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

Protected Attributes
FEProblemBase &	_fe_problem
	FEProblem running this thread. More...

Detailed Description

Thread to compute threaded general user objects.

This works on a range of thread IDs, so that we always compute all user objects for every threaded copy.

Definition at line 34 of file ComputeThreadedGeneralUserObjectsThread.h.

Constructor & Destructor Documentation

◆ ComputeThreadedGeneralUserObjectsThread() [1/2]

ComputeThreadedGeneralUserObjectsThread::ComputeThreadedGeneralUserObjectsThread ( FEProblemBase & fe_problem )

Definition at line 12 of file ComputeThreadedGeneralUserObjectsThread.C.

   : _fe_problem(fe_problem)
 {
 }

◆ ComputeThreadedGeneralUserObjectsThread() [2/2]

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

Definition at line 18 of file ComputeThreadedGeneralUserObjectsThread.C.

   : _fe_problem(x._fe_problem)
 {
 }

◆ ~ComputeThreadedGeneralUserObjectsThread()

ComputeThreadedGeneralUserObjectsThread::~ComputeThreadedGeneralUserObjectsThread ( )

virtual

Definition at line 24 of file ComputeThreadedGeneralUserObjectsThread.C.

24 {}

Member Function Documentation

◆ caughtMooseException()

void ComputeThreadedGeneralUserObjectsThread::caughtMooseException ( MooseException & e )

virtual

Called if a MooseException is caught anywhere during the computation.

The single input parameter taken is a MooseException object.

Definition at line 27 of file ComputeThreadedGeneralUserObjectsThread.C.

Referenced by operator()().

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

◆ join()

void ComputeThreadedGeneralUserObjectsThread::join ( const ComputeThreadedGeneralUserObjectsThread & )

inline

Definition at line 45 of file ComputeThreadedGeneralUserObjectsThread.h.

45 {}

◆ operator()()

void ComputeThreadedGeneralUserObjectsThread::operator() ( const GeneralUserObjectRange & range )

Definition at line 36 of file ComputeThreadedGeneralUserObjectsThread.C.

 {
   try
   {
     printGeneralExecutionInformation(range);
     for (auto it = range.begin(); it != range.end(); ++it)
     {
       auto & tguo = *it;
       tguo->execute();
     }
   }
   catch (MooseException & e)
   {
     caughtMooseException(e);
   }
 }

◆ printGeneralExecutionInformation()

void ComputeThreadedGeneralUserObjectsThread::printGeneralExecutionInformation ( const GeneralUserObjectRange & range ) const

protected

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

Definition at line 54 of file ComputeThreadedGeneralUserObjectsThread.C.

Referenced by operator()().

 {
   // TODO: Threaded UOs dont know their thread number so this will print too often
   if (!_fe_problem.shouldPrintExecution(0) || !range.size())
     return;
 
   const auto & console = _fe_problem.console();
   const auto & execute_on = _fe_problem.getCurrentExecuteOnFlag();
   console << "[DBG] Executing Threaded General User Object " << (*range.begin())->name() << " on "
           << execute_on << std::endl;
 }