www.mooseframework.org
Classes | Namespaces | Typedefs | Functions | Variables
Moose.h File Reference

Go to the source code of this file.

Classes

class  libMesh::NumericVector< T >
 
class  libMesh::SparseMatrix< T >
 
class  Moose::ScopedCommSwapper
 

Namespaces

 libMesh
 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.
 
 Moose
 MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to address this in their environment if C++17 compatibility isn't found.
 

Typedefs

template<typename T >
using libMesh::UniquePtr = std::unique_ptr< T >
 
using ExecFlagType = MooseEnumItem
 

Functions

void MooseVecView (NumericVector< Number > &vector)
 
void MooseVecView (const NumericVector< Number > &vector)
 
void MooseMatView (SparseMatrix< Number > &mat)
 
void MooseMatView (const SparseMatrix< Number > &mat)
 
template<class M , class... Args>
std::pair< typename M::iterator, bool > moose_try_emplace (M &m, const typename M::key_type &k, Args &&... args)
 Function to mirror the behavior of the C++17 std::map::try_emplace() method (no hint). More...
 
bool Moose::colorConsole ()
 Returns whether Console coloring is turned on (default: true). More...
 
bool Moose::setColorConsole (bool use_color, bool force=false)
 Turns color escape sequences on/off for info written to stdout. More...
 
void Moose::registerAll (Factory &f, ActionFactory &af, Syntax &s)
 Register objects that are in MOOSE. More...
 
void Moose::registerObjects (Factory &factory)
 
void Moose::registerObjects (Factory &factory, const std::set< std::string > &obj_labels)
 
void Moose::addActionTypes (Syntax &syntax)
 
void Moose::registerActions (Syntax &syntax, ActionFactory &action_factory)
 Multiple Action class can be associated with a single input file section, in which case all associated Actions will be created and "acted" on when the associated input file section is seen. More...
 
void Moose::registerActions (Syntax &syntax, ActionFactory &action_factory, const std::set< std::string > &obj_labels)
 
void Moose::associateSyntax (Syntax &syntax, ActionFactory &action_factory)
 
void Moose::setSolverDefaults (FEProblemBase &problem)
 
MPI_Comm Moose::swapLibMeshComm (MPI_Comm new_comm)
 Swap the libMesh MPI communicator out for ours. More...
 

Variables

const ExecFlagType EXEC_NONE
 
const ExecFlagType EXEC_INITIAL
 
const ExecFlagType EXEC_LINEAR
 
const ExecFlagType EXEC_NONLINEAR
 
const ExecFlagType EXEC_POSTCHECK
 
const ExecFlagType EXEC_TIMESTEP_END
 
const ExecFlagType EXEC_TIMESTEP_BEGIN
 
const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_BEGIN
 
const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_END
 
const ExecFlagType EXEC_FINAL
 
const ExecFlagType EXEC_FORCED
 
const ExecFlagType EXEC_FAILED
 
const ExecFlagType EXEC_CUSTOM
 
const ExecFlagType EXEC_SUBDOMAIN
 
const ExecFlagType EXEC_PRE_DISPLACE
 
const ExecFlagType EXEC_SAME_AS_MULTIAPP
 
const ExecFlagType EXEC_PRE_MULTIAPP_SETUP
 
const ExecFlagType EXEC_TRANSFER
 
const ExecFlagType EXEC_PRE_KERNELS
 
const ExecFlagType EXEC_ALWAYS
 
static constexpr std::size_t Moose::dim = LIBMESH_DIM
 This is the dimension of all vector and tensor datastructures used in MOOSE. More...
 
int Moose::interrupt_signal_number = 0
 Used by the signal handler to determine if we should write a checkpoint file out at any point during operation. More...
 
bool Moose::show_trace = true
 Set to true (the default) to print the stack trace with error and warning messages - false to omit it. More...
 
bool Moose::show_multiple = false
 Set to false (the default) to display an error message only once for each error call code location (as opposed to every time the code is executed). More...
 
PerfLog Moose::perf_log
 Perflog to be used by applications. More...
 
bool Moose::_trap_fpe
 Variable indicating whether we will enable FPE trapping for this run. More...
 
bool Moose::_warnings_are_errors = false
 Variable to toggle any warning into an error (includes deprecated code warnings) More...
 
bool Moose::_deprecated_is_error = false
 Variable to toggle only deprecated warnings as errors. More...
 
bool Moose::_throw_on_error = false
 Variable to turn on exceptions during mooseError(), should only be used within MOOSE unit tests or when about to perform threaded operations because exception throwing in threaded regions is safe while aborting is inherently not when singletons are involved (e.g. More...
 
bool Moose::_throw_on_warning = false
 Variable to turn on exceptions during mooseWarning(), should only be used in MOOSE unit tests. More...
 
ExecFlagEnum Moose::execute_flags
 Storage for the registered execute flags. More...
 

Typedef Documentation

◆ ExecFlagType

Definition at line 114 of file Moose.h.

Function Documentation

◆ moose_try_emplace()

template<class M , class... Args>
std::pair<typename M::iterator, bool> moose_try_emplace ( M &  m,
const typename M::key_type &  k,
Args &&...  args 
)

Function to mirror the behavior of the C++17 std::map::try_emplace() method (no hint).

Parameters
mThe std::map
kThe key use to insert the pair
argsThe value to be inserted. This can be a moveable type but won't be moved if the insertion is successful.

Definition at line 94 of file Moose.h.

Referenced by Adaptivity::getErrorVector(), TableOutput::outputReporter(), TableOutput::outputVectorPostprocessors(), and FEProblemBase::registerRandomInterface().

95 {
96  auto it = m.lower_bound(k);
97  if (it == m.end() || m.key_comp()(k, it->first))
98  {
99  return {m.emplace_hint(it,
100  std::piecewise_construct,
101  std::forward_as_tuple(k),
102  std::forward_as_tuple(std::forward<Args>(args)...)),
103  true};
104  }
105  return {it, false};
106 }

◆ MooseMatView() [1/2]

void MooseMatView ( SparseMatrix< Number > &  mat)

◆ MooseMatView() [2/2]

void MooseMatView ( const SparseMatrix< Number > &  mat)

◆ MooseVecView() [1/2]

void MooseVecView ( NumericVector< Number > &  vector)

◆ MooseVecView() [2/2]

void MooseVecView ( const NumericVector< Number > &  vector)

Variable Documentation

◆ EXEC_ALWAYS

const ExecFlagType EXEC_ALWAYS

◆ EXEC_CUSTOM

const ExecFlagType EXEC_CUSTOM

◆ EXEC_FAILED

const ExecFlagType EXEC_FAILED

◆ EXEC_FINAL

const ExecFlagType EXEC_FINAL

◆ EXEC_FORCED

const ExecFlagType EXEC_FORCED

◆ EXEC_INITIAL

const ExecFlagType EXEC_INITIAL

Definition at line 28 of file Moose.C.

Referenced by MultiAppGeneralFieldTransfer::acceptPointInOriginMesh(), ElementIDOutputAction::act(), AddNodalNormalsAction::act(), FEProblemBase::addOutput(), ChangeOverFixedPointPostprocessor::ChangeOverFixedPointPostprocessor(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), Checkpoint::Checkpoint(), MultiAppGeneralFieldTransfer::closestToPosition(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), NearestPositionsDivision::divisionIndex(), PseudoTimestep::execute(), PositionsFunctorValueSampler::execute(), Steady::execute(), Eigenvalue::execute(), EigenProblem::execute(), FEProblemBase::execute(), Control::getExecuteOptions(), Material::getMaterialByName(), MultiAppGeneralFieldNearestLocationTransfer::getNumDivisions(), MultiAppGeneralFieldNearestLocationTransfer::getNumSources(), MaterialOutputAction::getParams(), NumPositions::getValue(), groupUserObjects(), NonlinearEigen::init(), InversePowerMethod::init(), EigenExecutionerBase::init(), DistributedPositions::initialize(), TransformedPositions::initialize(), PositionsFunctorValueSampler::initialize(), IntegralPreservingFunctionIC::initialSetup(), Console::initialSetup(), RandomICBase::initialSetup(), FEProblemBase::initialSetup(), EigenExecutionerBase::normalizeSolution(), FEProblemBase::objectSetupHelper(), ControlOutput::output(), Console::output(), OutputOnWarehouse::OutputOnWarehouse(), OversampleOutput::outputStep(), Output::outputStep(), Transient::preExecute(), ProjectedStatefulMaterialStorageAction::processProperty(), RandomICBase::RandomICBase(), MultiApp::restore(), ExecuteMooseObjectWarehouse< Transfer >::setup(), RandomData::updateSeeds(), JSONOutput::validParams(), ElementQualityChecker::validParams(), JSONFileReader::validParams(), Console::validParams(), AccumulateReporter::validParams(), PseudoTimestep::validParams(), MultiAppPositions::validParams(), MessageFromInput::validParams(), ControlOutput::validParams(), GhostingAux::validParams(), ReporterDebugOutput::validParams(), DOFMapOutput::validParams(), InterfaceQpUserObjectBase::validParams(), MaterialPropertyDebugOutput::validParams(), Exodus::validParams(), CommonOutputAction::validParams(), GhostingUserObject::validParams(), PropertyReadFile::validParams(), Control::validParams(), and Output::validParams().

◆ EXEC_LINEAR

const ExecFlagType EXEC_LINEAR

◆ EXEC_MULTIAPP_FIXED_POINT_BEGIN

const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_BEGIN

◆ EXEC_MULTIAPP_FIXED_POINT_END

const ExecFlagType EXEC_MULTIAPP_FIXED_POINT_END

◆ EXEC_NONE

const ExecFlagType EXEC_NONE

◆ EXEC_NONLINEAR

const ExecFlagType EXEC_NONLINEAR

◆ EXEC_POSTCHECK

const ExecFlagType EXEC_POSTCHECK

◆ EXEC_PRE_DISPLACE

const ExecFlagType EXEC_PRE_DISPLACE

◆ EXEC_PRE_KERNELS

const ExecFlagType EXEC_PRE_KERNELS

◆ EXEC_PRE_MULTIAPP_SETUP

const ExecFlagType EXEC_PRE_MULTIAPP_SETUP

◆ EXEC_SAME_AS_MULTIAPP

const ExecFlagType EXEC_SAME_AS_MULTIAPP

Definition at line 45 of file Moose.C.

Referenced by FEProblemBase::addTransfer(), and MultiAppTransfer::validParams().

◆ EXEC_SUBDOMAIN

const ExecFlagType EXEC_SUBDOMAIN

◆ EXEC_TIMESTEP_BEGIN

const ExecFlagType EXEC_TIMESTEP_BEGIN

◆ EXEC_TIMESTEP_END

const ExecFlagType EXEC_TIMESTEP_END

◆ EXEC_TRANSFER

const ExecFlagType EXEC_TRANSFER