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
 

Typedefs

using ExecFlagType = MooseEnumItem
 

Functions

void MooseVecView (NumericVector< Number > &vector)
 
void MooseMatView (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::registerExecFlags (Factory &factory)
 
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_TIMESTEP_END
 
const ExecFlagType EXEC_TIMESTEP_BEGIN
 
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
 
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() and mooseWarning(), should only be used with MOOSE unit. More...
 
ExecFlagEnum Moose::execute_flags
 Storage for the registered execute flags. More...
 

Typedef Documentation

◆ ExecFlagType

Definition at line 95 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 75 of file Moose.h.

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

76 {
77  auto it = m.lower_bound(k);
78  if (it == m.end() || m.key_comp()(k, it->first))
79  {
80  return {m.emplace_hint(it,
81  std::piecewise_construct,
82  std::forward_as_tuple(k),
83  std::forward_as_tuple(std::forward<Args>(args)...)),
84  true};
85  }
86  return {it, false};
87 }
PetscInt m

◆ MooseMatView()

void MooseMatView ( SparseMatrix< Number > &  mat)

◆ MooseVecView()

void MooseVecView ( NumericVector< Number > &  vector)

Definition at line 51 of file Moose.C.

52 {
53  PetscVector<Number> & petsc_vec = static_cast<PetscVector<Number> &>(vector);
54  VecView(petsc_vec.vec(), 0);
55 }

Variable Documentation

◆ 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

◆ EXEC_LINEAR

const ExecFlagType EXEC_LINEAR

◆ EXEC_NONE

const ExecFlagType EXEC_NONE

◆ EXEC_NONLINEAR

const ExecFlagType EXEC_NONLINEAR

◆ EXEC_PRE_DISPLACE

const ExecFlagType EXEC_PRE_DISPLACE

◆ EXEC_PRE_MULTIAPP_SETUP

const ExecFlagType EXEC_PRE_MULTIAPP_SETUP

◆ EXEC_SAME_AS_MULTIAPP

const ExecFlagType EXEC_SAME_AS_MULTIAPP

◆ 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