https://mooseframework.inl.gov
Classes | Namespaces | Typedefs | Enumerations | Functions | Variables
MooseTypes.h File Reference

Go to the source code of this file.

Classes

class  MooseArray< T >
 forward declarations More...
 
class  MaterialProperty< T >
 
class  ADMaterialProperty< T >
 
struct  libMesh::TensorTools::IncrementRank< Eigen::Matrix< Real, Eigen::Dynamic, 1 > >
 
struct  libMesh::TensorTools::IncrementRank< Eigen::Matrix< Real, Eigen::Dynamic, Moose::dim > >
 
struct  libMesh::TensorTools::DecrementRank< Eigen::Matrix< Real, Eigen::Dynamic, Moose::dim > >
 
struct  MetaPhysicL::ReplaceAlgebraicType< libMesh::RealEigenVector, U >
 
struct  Moose::ShapeType< OutputType >
 
struct  Moose::ShapeType< Eigen::Matrix< Real, Eigen::Dynamic, 1 > >
 
struct  Moose::DOFType< OutputType >
 
struct  Moose::DOFType< RealVectorValue >
 
struct  OutputTools< OutputType >
 
struct  Moose::ADType< T >
 
struct  Moose::ADType< Real >
 
struct  Moose::ADType< ChainedReal >
 
struct  Moose::ADType< Point >
 
struct  Moose::ADType< RealVectorValue >
 
struct  Moose::ADType< RankTwoTensor >
 
struct  Moose::ADType< RankThreeTensor >
 
struct  Moose::ADType< RankFourTensor >
 
struct  Moose::ADType< SymmetricRankTwoTensor >
 
struct  Moose::ADType< SymmetricRankFourTensor >
 
struct  Moose::ADType< W< T > >
 
struct  Moose::ADType< std::vector< T, std::allocator< T > > >
 
struct  Moose::ADType< std::list< T, std::allocator< T > > >
 
struct  Moose::ADType< std::set< T, std::less< T >, std::allocator< T > > >
 
struct  Moose::ADType< DenseVector< T > >
 
struct  Moose::ADType< DenseMatrix< T > >
 
struct  Moose::ADType< RealEigenVector >
 
struct  Moose::ADType< VariableValue >
 
struct  Moose::ADType< VariableGradient >
 
struct  Moose::ADType< VariableSecond >
 
struct  Moose::ADType< ADReal >
 
struct  Moose::ADType< ChainedADReal >
 
struct  Moose::ADType< ADRankTwoTensor >
 
struct  Moose::ADType< ADRankThreeTensor >
 
struct  Moose::ADType< ADRankFourTensor >
 
struct  Moose::ADType< ADSymmetricRankTwoTensor >
 
struct  Moose::ADType< ADSymmetricRankFourTensor >
 
struct  Moose::ADType< ADVariableValue >
 
struct  Moose::ADType< ADVariableGradient >
 
struct  Moose::ADType< ADVariableSecond >
 
struct  Moose::IsADType< T >
 
struct  Moose::IsADType< ADReal >
 
struct  Moose::IsADType< ADPoint >
 
struct  Moose::IsADType< W< T, Args... > >
 
struct  Moose::IsADType< MetaPhysicL::DualNumber< T, Args... > >
 
struct  enable_bitmask_operators< Moose::RelationshipManagerType >
 

Namespaces

 libMesh
 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.
 
 libMesh::TensorTools
 
 MetaPhysicL
 We need to instantiate the following CompareTypes to tell the compiler that ADReal is a subtype of ChainedADReal.
 
 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

typedef Eigen::Matrix< Real, Moose::dim, 1 > libMesh::RealDIMValue
 
typedef Eigen::Matrix< Real, Eigen::Dynamic, 1 > libMesh::RealEigenVector
 
typedef Eigen::Matrix< Real, Eigen::Dynamic, Moose::dimlibMesh::RealVectorArrayValue
 
typedef Eigen::Matrix< Real, Eigen::Dynamic, Moose::dim *Moose::dimlibMesh::RealTensorArrayValue
 
typedef Eigen::Matrix< Real, Eigen::Dynamic, Eigen::Dynamic > libMesh::RealEigenMatrix
 
typedef TensorValue< ReallibMesh::RealTensorValue
 
typedef Real PostprocessorValue
 various MOOSE typedefs More...
 
typedef std::vector< RealVectorPostprocessorValue
 
typedef Real ScatterVectorPostprocessorValue
 
typedef boundary_id_type BoundaryID
 
typedef unsigned int InterfaceID
 
typedef subdomain_id_type SubdomainID
 
typedef unsigned int MooseObjectID
 
typedef unsigned int THREAD_ID
 
typedef unsigned int TagID
 
typedef unsigned int TagTypeID
 
typedef unsigned int PerfID
 
typedef unsigned int InvalidSolutionID
 
using RestartableDataMapName = std::string
 
typedef libMesh::StoredRange< std::vector< dof_id_type >::iterator, dof_id_typeNodeIdRange
 
typedef libMesh::StoredRange< std::vector< const Elem * >::iterator, const Elem * > ConstElemPointerRange
 
typedef OutputTools< Real >::VariableValue VariableValue
 
typedef OutputTools< Real >::VariableGradient VariableGradient
 
typedef OutputTools< Real >::VariableSecond VariableSecond
 
typedef OutputTools< Real >::VariableCurl VariableCurl
 
typedef OutputTools< Real >::VariableDivergence VariableDivergence
 
typedef OutputTools< Real >::VariablePhiValue VariablePhiValue
 
typedef OutputTools< Real >::VariablePhiGradient VariablePhiGradient
 
typedef OutputTools< Real >::VariablePhiSecond VariablePhiSecond
 
typedef OutputTools< Real >::VariablePhiCurl VariablePhiCurl
 
typedef OutputTools< Real >::VariablePhiDivergence VariablePhiDivergence
 
typedef OutputTools< Real >::VariableTestValue VariableTestValue
 
typedef OutputTools< Real >::VariableTestGradient VariableTestGradient
 
typedef OutputTools< Real >::VariableTestSecond VariableTestSecond
 
typedef OutputTools< Real >::VariableTestCurl VariableTestCurl
 
typedef OutputTools< Real >::VariableTestDivergence VariableTestDivergence
 
typedef OutputTools< RealVectorValue >::VariableValue VectorVariableValue
 
typedef OutputTools< RealVectorValue >::VariableGradient VectorVariableGradient
 
typedef OutputTools< RealVectorValue >::VariableSecond VectorVariableSecond
 
typedef OutputTools< RealVectorValue >::VariableCurl VectorVariableCurl
 
typedef OutputTools< RealVectorValue >::VariableDivergence VectorVariableDivergence
 
typedef OutputTools< RealVectorValue >::VariablePhiValue VectorVariablePhiValue
 
typedef OutputTools< RealVectorValue >::VariablePhiGradient VectorVariablePhiGradient
 
typedef OutputTools< RealVectorValue >::VariablePhiSecond VectorVariablePhiSecond
 
typedef OutputTools< RealVectorValue >::VariablePhiCurl VectorVariablePhiCurl
 
typedef OutputTools< RealVectorValue >::VariablePhiDivergence VectorVariablePhiDivergence
 
typedef OutputTools< RealVectorValue >::VariableTestValue VectorVariableTestValue
 
typedef OutputTools< RealVectorValue >::VariableTestGradient VectorVariableTestGradient
 
typedef OutputTools< RealVectorValue >::VariableTestSecond VectorVariableTestSecond
 
typedef OutputTools< RealVectorValue >::VariableTestCurl VectorVariableTestCurl
 
typedef OutputTools< RealVectorValue >::VariableTestDivergence VectorVariableTestDivergence
 
typedef OutputTools< RealEigenVector >::VariableValue ArrayVariableValue
 
typedef OutputTools< RealEigenVector >::VariableGradient ArrayVariableGradient
 
typedef OutputTools< RealEigenVector >::VariableSecond ArrayVariableSecond
 
typedef OutputTools< RealEigenVector >::VariableCurl ArrayVariableCurl
 
typedef OutputTools< RealEigenVector >::VariableDivergence ArrayVariableDivergence
 
typedef OutputTools< RealEigenVector >::VariablePhiValue ArrayVariablePhiValue
 
typedef OutputTools< RealEigenVector >::VariablePhiGradient ArrayVariablePhiGradient
 
typedef std::vector< std::vector< Eigen::Map< RealDIMValue > > > MappedArrayVariablePhiGradient
 
typedef OutputTools< RealEigenVector >::VariablePhiSecond ArrayVariablePhiSecond
 
typedef OutputTools< RealEigenVector >::VariablePhiCurl ArrayVariablePhiCurl
 
typedef OutputTools< RealEigenVector >::VariablePhiDivergence ArrayVariablePhiDivergence
 
typedef OutputTools< RealEigenVector >::VariableTestValue ArrayVariableTestValue
 
typedef OutputTools< RealEigenVector >::VariableTestGradient ArrayVariableTestGradient
 
typedef OutputTools< RealEigenVector >::VariableTestSecond ArrayVariableTestSecond
 
typedef OutputTools< RealEigenVector >::VariableTestCurl ArrayVariableTestCurl
 
typedef OutputTools< RealEigenVector >::VariableTestDivergence ArrayVariableTestDivergence
 
typedef libMesh::VectorValue< ADRealADRealVectorValue
 AD typedefs. More...
 
typedef ADRealVectorValue ADRealGradient
 
typedef libMesh::VectorValue< ADRealADPoint
 
typedef libMesh::TensorValue< ADRealADRealTensorValue
 
typedef libMesh::DenseMatrix< ADRealADDenseMatrix
 
typedef libMesh::DenseVector< ADRealADDenseVector
 
typedef MooseArray< ADRealADVariableValue
 
typedef MooseArray< ADRealVectorValueADVariableGradient
 
typedef MooseArray< ADRealTensorValueADVariableSecond
 
typedef MooseArray< ADRealVectorValueADVectorVariableValue
 
typedef MooseArray< ADRealTensorValueADVectorVariableGradient
 
typedef MooseArray< libMesh::TypeNTensor< 3, ADReal > > ADVectorVariableSecond
 
typedef MooseArray< ADRealVectorValueADVectorVariableCurl
 
template<typename T >
using ADTemplateVariableValue = typename OutputTools< typename Moose::ADType< T >::type >::VariableValue
 
template<typename T >
using ADTemplateVariableGradient = typename OutputTools< typename Moose::ADType< T >::type >::VariableGradient
 
template<typename T >
using ADTemplateVariableSecond = typename OutputTools< typename Moose::ADType< T >::type >::VariableSecond
 
template<typename T >
using ADTemplateVariableCurl = typename OutputTools< typename Moose::ADType< T >::type >::VariableCurl
 
typedef VariableTestValue ADVariableTestValue
 
typedef VariableTestGradient ADVariableTestGradient
 
typedef VariableTestSecond ADVariableTestSecond
 
typedef VectorVariableTestValue ADVectorVariableTestValue
 
typedef VectorVariableTestGradient ADVectorVariableTestGradient
 
typedef VectorVariableTestSecond ADVectorVariableTestSecond
 
template<typename T >
using ADTemplateVariableTestValue = typename OutputTools< T >::VariableTestValue
 
template<typename T >
using ADTemplateVariablePhiValue = typename OutputTools< T >::VariablePhiValue
 
template<typename T >
using ADTemplateVariableTestGradient = typename OutputTools< typename Moose::ADType< T >::type >::VariableTestGradient
 
template<typename T >
using ADTemplateVariableTestSecond = typename OutputTools< typename Moose::ADType< T >::type >::VariableTestSecond
 
template<typename T >
using ADTemplateVariablePhiGradient = typename OutputTools< typename Moose::ADType< T >::type >::VariablePhiGradient
 
using ADVariablePhiGradient = ADTemplateVariablePhiGradient< Real >
 
template<typename T , bool is_ad>
using Moose::GenericType = typename std::conditional< is_ad, typename ADType< T >::type, T >::type
 
template<bool is_ad>
using GenericReal = Moose::GenericType< Real, is_ad >
 
template<bool is_ad>
using GenericChainedReal = Moose::GenericType< ChainedReal, is_ad >
 
template<bool is_ad>
using GenericRealVectorValue = Moose::GenericType< RealVectorValue, is_ad >
 
template<bool is_ad>
using GenericRealTensorValue = Moose::GenericType< RealTensorValue, is_ad >
 
template<bool is_ad>
using GenericRankTwoTensor = Moose::GenericType< RankTwoTensor, is_ad >
 
template<bool is_ad>
using GenericRankThreeTensor = Moose::GenericType< RankThreeTensor, is_ad >
 
template<bool is_ad>
using GenericRankFourTensor = Moose::GenericType< RankFourTensor, is_ad >
 
template<bool is_ad>
using GenericVariableValue = Moose::GenericType< VariableValue, is_ad >
 
template<bool is_ad>
using GenericVectorVariableValue = Moose::GenericType< VectorVariableValue, is_ad >
 
template<bool is_ad>
using GenericVariableGradient = Moose::GenericType< VariableGradient, is_ad >
 
template<bool is_ad>
using GenericVariableSecond = Moose::GenericType< VariableSecond, is_ad >
 
template<bool is_ad>
using GenericDenseVector = Moose::GenericType< DenseVector< Real >, is_ad >
 
template<bool is_ad>
using GenericDenseMatrix = Moose::GenericType< DenseMatrix< Real >, is_ad >
 
typedef std::function< void(const InputParameters &, InputParameters &)> Moose::RelationshipManagerInputParameterCallback
 The type for the callback to set RelationshipManager parameters. More...
 
typedef std::vector< VariableName > CoupledName
 additional MOOSE typedefs More...
 

Enumerations

enum  Moose::SolutionState : int { Moose::Current = 0, Moose::Old = 1, Moose::Older = 2, Moose::PreviousNL = -1 }
 
enum  Moose::SolutionIterationType : unsigned short { Moose::SolutionIterationType::Time = 0, Moose::SolutionIterationType::Nonlinear }
 
enum  Moose::GeometryType { Moose::Volume, Moose::Face }
 
enum  Moose::MaterialDataType {
  Moose::BLOCK_MATERIAL_DATA, Moose::BOUNDARY_MATERIAL_DATA, Moose::FACE_MATERIAL_DATA, Moose::NEIGHBOR_MATERIAL_DATA,
  Moose::INTERFACE_MATERIAL_DATA
}
 MaterialData types. More...
 
enum  Moose::AuxGroup { Moose::PRE_IC = 0, Moose::PRE_AUX = 1, Moose::POST_AUX = 2, Moose::ALL = 3 }
 Flag for AuxKernel related execution type. More...
 
enum  Moose::VarKindType { Moose::VAR_SOLVER, Moose::VAR_AUXILIARY, Moose::VAR_ANY }
 Framework-wide stuff. More...
 
enum  Moose::VarFieldType {
  Moose::VAR_FIELD_STANDARD, Moose::VAR_FIELD_SCALAR, Moose::VAR_FIELD_VECTOR, Moose::VAR_FIELD_ARRAY,
  Moose::VAR_FIELD_ANY
}
 
enum  Moose::CouplingType { Moose::COUPLING_DIAG, Moose::COUPLING_FULL, Moose::COUPLING_CUSTOM }
 
enum  Moose::ConstraintSideType { Moose::SIDE_PRIMARY, Moose::SIDE_SECONDARY }
 
enum  Moose::DGResidualType { Moose::Element, Moose::Neighbor }
 
enum  Moose::DGJacobianType { Moose::ElementElement, Moose::ElementNeighbor, Moose::NeighborElement, Moose::NeighborNeighbor }
 
enum  Moose::ConstraintType { Moose::Secondary = Element, Moose::Primary = Neighbor }
 
enum  Moose::ElementType : unsigned int { Moose::ElementType::Element = DGResidualType::Element, Moose::ElementType::Neighbor = DGResidualType::Neighbor, Moose::ElementType::Lower = DGResidualType::Neighbor + 1 }
 
enum  Moose::MortarType : unsigned int { Moose::MortarType::Secondary = static_cast<unsigned int>(Moose::ElementType::Element), Moose::MortarType::Primary = static_cast<unsigned int>(Moose::ElementType::Neighbor), Moose::MortarType::Lower = static_cast<unsigned int>(Moose::ElementType::Lower) }
 
enum  Moose::ComputeType { Moose::ComputeType::Residual, Moose::ComputeType::Jacobian, Moose::ComputeType::ResidualAndJacobian }
 The type of nonlinear computation being performed. More...
 
enum  Moose::RESTARTABLE_FILTER : unsigned char { Moose::RESTARTABLE_FILTER::RECOVERABLE }
 The filter type applied to a particular piece of "restartable" data. More...
 
enum  Moose::ConstraintJacobianType {
  Moose::SecondarySecondary = ElementElement, Moose::SecondaryPrimary = ElementNeighbor, Moose::PrimarySecondary = NeighborElement, Moose::PrimaryPrimary = NeighborNeighbor,
  Moose::LowerLower, Moose::LowerSecondary, Moose::LowerPrimary, Moose::SecondaryLower,
  Moose::PrimaryLower
}
 
enum  Moose::CoordinateSystemType : int { Moose::COORD_XYZ = 0, Moose::COORD_RZ, Moose::COORD_RSPHERICAL }
 
enum  Moose::PCSideType { Moose::PCS_LEFT, Moose::PCS_RIGHT, Moose::PCS_SYMMETRIC, Moose::PCS_DEFAULT }
 Preconditioning side. More...
 
enum  Moose::MooseKSPNormType {
  Moose::KSPN_NONE, Moose::KSPN_PRECONDITIONED, Moose::KSPN_UNPRECONDITIONED, Moose::KSPN_NATURAL,
  Moose::KSPN_DEFAULT
}
 Norm type for converge test. More...
 
enum  Moose::SolveType {
  Moose::ST_PJFNK, Moose::ST_JFNK, Moose::ST_NEWTON, Moose::ST_FD,
  Moose::ST_LINEAR
}
 Type of the solve. More...
 
enum  Moose::EigenSolveType {
  Moose::EST_POWER, Moose::EST_ARNOLDI, Moose::EST_KRYLOVSCHUR, Moose::EST_JACOBI_DAVIDSON,
  Moose::EST_NONLINEAR_POWER, Moose::EST_NEWTON, Moose::EST_PJFNK, Moose::EST_PJFNKMO,
  Moose::EST_JFNK
}
 Type of the eigen solve. More...
 
enum  Moose::EigenProblemType {
  Moose::EPT_HERMITIAN, Moose::EPT_NON_HERMITIAN, Moose::EPT_GEN_HERMITIAN, Moose::EPT_GEN_INDEFINITE,
  Moose::EPT_GEN_NON_HERMITIAN, Moose::EPT_POS_GEN_NON_HERMITIAN, Moose::EPT_SLEPC_DEFAULT
}
 Type of the eigen problem. More...
 
enum  Moose::WhichEigenPairs {
  Moose::WEP_LARGEST_MAGNITUDE, Moose::WEP_SMALLEST_MAGNITUDE, Moose::WEP_LARGEST_REAL, Moose::WEP_SMALLEST_REAL,
  Moose::WEP_LARGEST_IMAGINARY, Moose::WEP_SMALLEST_IMAGINARY, Moose::WEP_TARGET_MAGNITUDE, Moose::WEP_TARGET_REAL,
  Moose::WEP_TARGET_IMAGINARY, Moose::WEP_ALL_EIGENVALUES, Moose::WEP_SLEPC_DEFAULT
}
 Which eigen pairs. More...
 
enum  Moose::TimeIntegratorType {
  Moose::TI_IMPLICIT_EULER, Moose::TI_EXPLICIT_EULER, Moose::TI_CRANK_NICOLSON, Moose::TI_BDF2,
  Moose::TI_EXPLICIT_MIDPOINT, Moose::TI_LSTABLE_DIRK2, Moose::TI_EXPLICIT_TVD_RK_2, Moose::TI_NEWMARK_BETA
}
 Time integrators. More...
 
enum  Moose::ConstraintFormulationType { Moose::Penalty, Moose::Kinematic }
 Type of constraint formulation. More...
 
enum  Moose::LineSearchType {
  Moose::LS_INVALID, Moose::LS_DEFAULT, Moose::LS_NONE, Moose::LS_BASIC,
  Moose::LS_SHELL, Moose::LS_CONTACT, Moose::LS_PROJECT, Moose::LS_L2,
  Moose::LS_BT, Moose::LS_CP
}
 Type of the line search. More...
 
enum  Moose::MffdType { Moose::MFFD_INVALID, Moose::MFFD_WP, Moose::MFFD_DS }
 Type of the matrix-free finite-differencing parameter. More...
 
enum  Moose::PatchUpdateType { Moose::Never, Moose::Always, Moose::Auto, Moose::Iteration }
 Type of patch update strategy for modeling node-face constraints or contact. More...
 
enum  Moose::RelationshipManagerType : unsigned char { Moose::RelationshipManagerType::DEFAULT = 0, Moose::RelationshipManagerType::GEOMETRIC = 1 << 0, Moose::RelationshipManagerType::ALGEBRAIC = 1 << 1, Moose::RelationshipManagerType::COUPLING = 1 << 2 }
 Main types of Relationship Managers. More...
 
enum  Moose::RMSystemType { Moose::NONLINEAR, Moose::AUXILIARY, Moose::NONE }
 
enum  Moose::VectorTagType { Moose::VECTOR_TAG_RESIDUAL = 0, Moose::VECTOR_TAG_SOLUTION = 1, Moose::VECTOR_TAG_ANY = 2 }
 
enum  Moose::FEBackend { Moose::FEBackend::LibMesh, Moose::FEBackend::MFEM }
 

Functions

template<typename T , typename std::enable_if< std::is_integral< T >::value >::type * = nullptr>
std::remove_const< T >::type _MooseIndex (T, int)
 
template<typename T >
decltype(std::declval< T >().size()) _MooseIndex (T &&, int)
 
template<typename T >
decltype("NOTE: MooseIndex only works with integers and objects with size()!") _MooseIndex (T, double)=delete
 
std::string Moose::stringify (const Moose::RelationshipManagerType &t)
 
std::string Moose::stringify (const Moose::TimeIntegratorType &t)
 
template<>
void libMesh::print_helper (std::ostream &os, const Moose::RelationshipManagerType *param)
 
 DerivativeStringClass (FileName)
 This type is for expected (i.e. More...
 
 DerivativeStringClass (FileNameNoExtension)
 Similar to FileName but without an extension. More...
 
 DerivativeStringClass (RelativeFileName)
 This type is for expected filenames that should be relative and will not have their values set to absolute paths like FileName. More...
 
 DerivativeStringClass (DataFileName)
 This type is for files used in the DataFileInterface, which enables searching of files within the registered data directory. More...
 
 DerivativeStringClass (MeshFileName)
 This type is similar to "FileName", but is used to further filter file dialogs on known file mesh types. More...
 
 DerivativeStringClass (MatrixFileName)
 This type is similar to "FileName", but is used to further filter file dialogs on known matrix file types. More...
 
 DerivativeStringClass (OutFileBase)
 This type is for output file base. More...
 
 DerivativeStringClass (NonlinearVariableName)
 This type is used for objects that expect nonlinear variable names (i.e. Kernels, BCs) More...
 
 DerivativeStringClass (LinearVariableName)
 This type is used for objects that expect linear variable names (i.e. LinearFVKernels, LinearFVBCs) More...
 
 DerivativeStringClass (SolverVariableName)
 This type is used for objects that expect linear or nonlinear solver variable names. More...
 
 DerivativeStringClass (AuxVariableName)
 This type is used for objects that expect Auxiliary variable names (i.e. AuxKernels, AuxBCs) More...
 
 DerivativeStringClass (VariableName)
 This type is used for objects that expect either Solver or Auxiliary Variables such as postprocessors. More...
 
 DerivativeStringClass (BoundaryName)
 This type is used for objects that expect Boundary Names/Ids read from or generated on the current mesh. More...
 
 DerivativeStringClass (SubdomainName)
 This type is similar to BoundaryName but is used for "blocks" or subdomains in the current mesh. More...
 
 DerivativeStringClass (PostprocessorName)
 This type is used for objects that expect Postprocessor objects. More...
 
 DerivativeStringClass (VectorPostprocessorName)
 This type is used for objects that expect VectorPostprocessor objects. More...
 
 DerivativeStringClass (MeshDivisionName)
 This type is used for objects that expect MeshDivision objects. More...
 
 DerivativeStringClass (FunctionName)
 This type is used for objects that expect Moose Function objects. More...
 
 DerivativeStringClass (DistributionName)
 This type is used for objects that expect Moose Distribution objects. More...
 
 DerivativeStringClass (SamplerName)
 This type is used for objects that expect Moose Sampler objects. More...
 
 DerivativeStringClass (UserObjectName)
 This type is used for objects that expect "UserObject" names. More...
 
 DerivativeStringClass (IndicatorName)
 This type is used for objects that expect an Indicator object name. More...
 
 DerivativeStringClass (MarkerName)
 This type is used for objects that expect an Marker object name. More...
 
 DerivativeStringClass (MultiAppName)
 This type is used for objects that expect an MultiApp object name. More...
 
 DerivativeStringClass (OutputName)
 Used for objects the require Output object names. More...
 
 DerivativeStringClass (MaterialPropertyName)
 Used for objects that expect MaterialProperty names. More...
 
 DerivativeStringClass (MooseFunctorName)
 Used for objects that expect Moose::Functor names. More...
 
 DerivativeStringClass (MaterialName)
 User for accessing Material objects. More...
 
 DerivativeStringClass (TagName)
 Tag Name. More...
 
 DerivativeStringClass (MeshGeneratorName)
 Name of MeshGenerators. More...
 
 DerivativeStringClass (ExtraElementIDName)
 Name of extra element IDs. More...
 
 DerivativeStringClass (ReporterValueName)
 Name of a Reporter Value, second argument to ReporterName (see Reporter.h) More...
 
 DerivativeStringClass (ComponentName)
 Name of a Component object. More...
 
 DerivativeStringClass (PhysicsName)
 Name of a Physics object. More...
 
 DerivativeStringClass (PositionsName)
 Name of a Positions object. More...
 
 DerivativeStringClass (TimesName)
 Name of a Times object. More...
 
 DerivativeStringClass (ExecutorName)
 Name of an Executor. Used for inputs to Executors. More...
 
 DerivativeStringClass (ParsedFunctionExpression)
 ParsedFunction/ParsedMaterial etc. FParser expression. More...
 
 DerivativeStringClass (NonlinearSystemName)
 System name support of multiple nonlinear systems on the same mesh. More...
 
 DerivativeStringClass (ConvergenceName)
 Name of a Convergence object. More...
 
 DerivativeStringClass (LinearSystemName)
 System name support of multiple linear systems on the same mesh. More...
 
 DerivativeStringClass (SolverSystemName)
 Name of a system which either be linear or nonlinear. More...
 
 DerivativeStringClass (CLIArgString)
 Command line argument, specialized to handle quotes in vector arguments. More...
 
 DerivativeStringClass (MFEMScalarCoefficientName)
 Coefficients used in input for MFEM residual objects. More...
 
 DerivativeStringClass (MFEMVectorCoefficientName)
 
 DerivativeStringClass (MFEMMatrixCoefficientName)
 

Variables

constexpr std::size_t Moose::constMaxQpsPerElem = 1000
 This is used for places where we initialize some qp-sized data structures that would end up being sized too small after the quadrature order gets bumped (dynamically in-sim). More...
 
template<class... Ts>
constexpr std::false_type Moose::always_false {}
 This is a helper variable template for cases when we want to use a default compile-time error with constexpr-based if conditions. More...
 
const processor_id_type Moose::INVALID_PROCESSOR_ID = libMesh::DofObject::invalid_processor_id
 
const SubdomainID Moose::ANY_BLOCK_ID = libMesh::Elem::invalid_subdomain_id - 1
 
const SubdomainID Moose::INVALID_BLOCK_ID = libMesh::Elem::invalid_subdomain_id
 
const BoundaryID Moose::ANY_BOUNDARY_ID = static_cast<BoundaryID>(-1)
 
const BoundaryID Moose::INVALID_BOUNDARY_ID = libMesh::BoundaryInfo::invalid_id
 
const TagID Moose::INVALID_TAG_ID = static_cast<TagID>(-1)
 
const TagTypeID Moose::INVALID_TAG_TYPE_ID = static_cast<TagTypeID>(-1)
 
const std::set< SubdomainIDMoose::EMPTY_BLOCK_IDS = {}
 
const std::set< BoundaryIDMoose::EMPTY_BOUNDARY_IDS = {}
 
const TagName Moose::SOLUTION_TAG = "SOLUTION"
 
const TagName Moose::OLD_SOLUTION_TAG = "SOLUTION_STATE_1"
 
const TagName Moose::OLDER_SOLUTION_TAG = "SOLUTION_STATE_2"
 
const TagName Moose::PREVIOUS_NL_SOLUTION_TAG = "U_PREVIOUS_NL_NEWTON"
 

Typedef Documentation

◆ ADDenseMatrix

Definition at line 372 of file MooseTypes.h.

◆ ADDenseVector

Definition at line 373 of file MooseTypes.h.

◆ ADPoint

Definition at line 370 of file MooseTypes.h.

◆ ADRealGradient

Definition at line 369 of file MooseTypes.h.

◆ ADRealTensorValue

Definition at line 371 of file MooseTypes.h.

◆ ADRealVectorValue

AD typedefs.

some AD typedefs for backwards compatibility

Definition at line 368 of file MooseTypes.h.

◆ ADTemplateVariableCurl

template<typename T >
using ADTemplateVariableCurl = typename OutputTools<typename Moose::ADType<T>::type>::VariableCurl

Definition at line 611 of file MooseTypes.h.

◆ ADTemplateVariableGradient

template<typename T >
using ADTemplateVariableGradient = typename OutputTools<typename Moose::ADType<T>::type>::VariableGradient

Definition at line 606 of file MooseTypes.h.

◆ ADTemplateVariablePhiGradient

template<typename T >
using ADTemplateVariablePhiGradient = typename OutputTools<typename Moose::ADType<T>::type>::VariablePhiGradient

Definition at line 637 of file MooseTypes.h.

◆ ADTemplateVariablePhiValue

template<typename T >
using ADTemplateVariablePhiValue = typename OutputTools<T>::VariablePhiValue

Definition at line 625 of file MooseTypes.h.

◆ ADTemplateVariableSecond

template<typename T >
using ADTemplateVariableSecond = typename OutputTools<typename Moose::ADType<T>::type>::VariableSecond

Definition at line 609 of file MooseTypes.h.

◆ ADTemplateVariableTestGradient

template<typename T >
using ADTemplateVariableTestGradient = typename OutputTools<typename Moose::ADType<T>::type>::VariableTestGradient

Definition at line 631 of file MooseTypes.h.

◆ ADTemplateVariableTestSecond

template<typename T >
using ADTemplateVariableTestSecond = typename OutputTools<typename Moose::ADType<T>::type>::VariableTestSecond

Definition at line 634 of file MooseTypes.h.

◆ ADTemplateVariableTestValue

template<typename T >
using ADTemplateVariableTestValue = typename OutputTools<T>::VariableTestValue

Definition at line 623 of file MooseTypes.h.

◆ ADTemplateVariableValue

template<typename T >
using ADTemplateVariableValue = typename OutputTools<typename Moose::ADType<T>::type>::VariableValue

Definition at line 603 of file MooseTypes.h.

◆ ADVariableGradient

Definition at line 375 of file MooseTypes.h.

◆ ADVariablePhiGradient

Definition at line 638 of file MooseTypes.h.

◆ ADVariableSecond

Definition at line 376 of file MooseTypes.h.

◆ ADVariableTestGradient

Definition at line 614 of file MooseTypes.h.

◆ ADVariableTestSecond

Definition at line 615 of file MooseTypes.h.

◆ ADVariableTestValue

Definition at line 613 of file MooseTypes.h.

◆ ADVariableValue

Definition at line 374 of file MooseTypes.h.

◆ ADVectorVariableCurl

Definition at line 380 of file MooseTypes.h.

◆ ADVectorVariableGradient

Definition at line 378 of file MooseTypes.h.

◆ ADVectorVariableSecond

Definition at line 379 of file MooseTypes.h.

◆ ADVectorVariableTestGradient

Definition at line 617 of file MooseTypes.h.

◆ ADVectorVariableTestSecond

Definition at line 618 of file MooseTypes.h.

◆ ADVectorVariableTestValue

Definition at line 616 of file MooseTypes.h.

◆ ADVectorVariableValue

Definition at line 377 of file MooseTypes.h.

◆ ArrayVariableCurl

typedef OutputTools<RealEigenVector>::VariableCurl ArrayVariableCurl

Definition at line 351 of file MooseTypes.h.

◆ ArrayVariableDivergence

Definition at line 352 of file MooseTypes.h.

◆ ArrayVariableGradient

Definition at line 349 of file MooseTypes.h.

◆ ArrayVariablePhiCurl

Definition at line 357 of file MooseTypes.h.

◆ ArrayVariablePhiDivergence

Definition at line 358 of file MooseTypes.h.

◆ ArrayVariablePhiGradient

Definition at line 354 of file MooseTypes.h.

◆ ArrayVariablePhiSecond

Definition at line 356 of file MooseTypes.h.

◆ ArrayVariablePhiValue

Definition at line 353 of file MooseTypes.h.

◆ ArrayVariableSecond

typedef OutputTools<RealEigenVector>::VariableSecond ArrayVariableSecond

Definition at line 350 of file MooseTypes.h.

◆ ArrayVariableTestCurl

Definition at line 362 of file MooseTypes.h.

◆ ArrayVariableTestDivergence

Definition at line 363 of file MooseTypes.h.

◆ ArrayVariableTestGradient

Definition at line 360 of file MooseTypes.h.

◆ ArrayVariableTestSecond

Definition at line 361 of file MooseTypes.h.

◆ ArrayVariableTestValue

Definition at line 359 of file MooseTypes.h.

◆ ArrayVariableValue

typedef OutputTools<RealEigenVector>::VariableValue ArrayVariableValue

Definition at line 348 of file MooseTypes.h.

◆ BoundaryID

Definition at line 205 of file MooseTypes.h.

◆ ConstElemPointerRange

typedef libMesh::StoredRange<std::vector<const Elem *>::iterator, const Elem *> ConstElemPointerRange

Definition at line 218 of file MooseTypes.h.

◆ CoupledName

typedef std::vector<VariableName> CoupledName

additional MOOSE typedefs

Definition at line 1191 of file MooseTypes.h.

◆ GenericChainedReal

template<bool is_ad>
using GenericChainedReal = Moose::GenericType<ChainedReal, is_ad>

Definition at line 650 of file MooseTypes.h.

◆ GenericDenseMatrix

template<bool is_ad>
using GenericDenseMatrix = Moose::GenericType<DenseMatrix<Real>, is_ad>

Definition at line 672 of file MooseTypes.h.

◆ GenericDenseVector

template<bool is_ad>
using GenericDenseVector = Moose::GenericType<DenseVector<Real>, is_ad>

Definition at line 670 of file MooseTypes.h.

◆ GenericRankFourTensor

template<bool is_ad>
using GenericRankFourTensor = Moose::GenericType<RankFourTensor, is_ad>

Definition at line 660 of file MooseTypes.h.

◆ GenericRankThreeTensor

template<bool is_ad>
using GenericRankThreeTensor = Moose::GenericType<RankThreeTensor, is_ad>

Definition at line 658 of file MooseTypes.h.

◆ GenericRankTwoTensor

template<bool is_ad>
using GenericRankTwoTensor = Moose::GenericType<RankTwoTensor, is_ad>

Definition at line 656 of file MooseTypes.h.

◆ GenericReal

template<bool is_ad>
using GenericReal = Moose::GenericType<Real, is_ad>

Definition at line 648 of file MooseTypes.h.

◆ GenericRealTensorValue

template<bool is_ad>
using GenericRealTensorValue = Moose::GenericType<RealTensorValue, is_ad>

Definition at line 654 of file MooseTypes.h.

◆ GenericRealVectorValue

template<bool is_ad>
using GenericRealVectorValue = Moose::GenericType<RealVectorValue, is_ad>

Definition at line 652 of file MooseTypes.h.

◆ GenericVariableGradient

template<bool is_ad>
using GenericVariableGradient = Moose::GenericType<VariableGradient, is_ad>

Definition at line 666 of file MooseTypes.h.

◆ GenericVariableSecond

template<bool is_ad>
using GenericVariableSecond = Moose::GenericType<VariableSecond, is_ad>

Definition at line 668 of file MooseTypes.h.

◆ GenericVariableValue

template<bool is_ad>
using GenericVariableValue = Moose::GenericType<VariableValue, is_ad>

Definition at line 662 of file MooseTypes.h.

◆ GenericVectorVariableValue

Definition at line 664 of file MooseTypes.h.

◆ InterfaceID

typedef unsigned int InterfaceID

Definition at line 206 of file MooseTypes.h.

◆ InvalidSolutionID

typedef unsigned int InvalidSolutionID

Definition at line 213 of file MooseTypes.h.

◆ MappedArrayVariablePhiGradient

typedef std::vector<std::vector<Eigen::Map<RealDIMValue> > > MappedArrayVariablePhiGradient

Definition at line 355 of file MooseTypes.h.

◆ MooseObjectID

typedef unsigned int MooseObjectID

Definition at line 208 of file MooseTypes.h.

◆ NodeIdRange

typedef libMesh::StoredRange<std::vector<dof_id_type>::iterator, dof_id_type> NodeIdRange

Definition at line 216 of file MooseTypes.h.

◆ PerfID

typedef unsigned int PerfID

Definition at line 212 of file MooseTypes.h.

◆ PostprocessorValue

various MOOSE typedefs

Definition at line 202 of file MooseTypes.h.

◆ RestartableDataMapName

using RestartableDataMapName = std::string

Definition at line 214 of file MooseTypes.h.

◆ ScatterVectorPostprocessorValue

Definition at line 204 of file MooseTypes.h.

◆ SubdomainID

Definition at line 207 of file MooseTypes.h.

◆ TagID

typedef unsigned int TagID

Definition at line 210 of file MooseTypes.h.

◆ TagTypeID

typedef unsigned int TagTypeID

Definition at line 211 of file MooseTypes.h.

◆ THREAD_ID

typedef unsigned int THREAD_ID

Definition at line 209 of file MooseTypes.h.

◆ VariableCurl

Definition at line 317 of file MooseTypes.h.

◆ VariableDivergence

Definition at line 318 of file MooseTypes.h.

◆ VariableGradient

Definition at line 315 of file MooseTypes.h.

◆ VariablePhiCurl

Definition at line 322 of file MooseTypes.h.

◆ VariablePhiDivergence

Definition at line 323 of file MooseTypes.h.

◆ VariablePhiGradient

Definition at line 320 of file MooseTypes.h.

◆ VariablePhiSecond

Definition at line 321 of file MooseTypes.h.

◆ VariablePhiValue

Definition at line 319 of file MooseTypes.h.

◆ VariableSecond

Definition at line 316 of file MooseTypes.h.

◆ VariableTestCurl

Definition at line 327 of file MooseTypes.h.

◆ VariableTestDivergence

Definition at line 328 of file MooseTypes.h.

◆ VariableTestGradient

Definition at line 325 of file MooseTypes.h.

◆ VariableTestSecond

Definition at line 326 of file MooseTypes.h.

◆ VariableTestValue

Definition at line 324 of file MooseTypes.h.

◆ VariableValue

Definition at line 314 of file MooseTypes.h.

◆ VectorPostprocessorValue

typedef std::vector<Real> VectorPostprocessorValue

Definition at line 203 of file MooseTypes.h.

◆ VectorVariableCurl

Definition at line 334 of file MooseTypes.h.

◆ VectorVariableDivergence

Definition at line 335 of file MooseTypes.h.

◆ VectorVariableGradient

Definition at line 332 of file MooseTypes.h.

◆ VectorVariablePhiCurl

Definition at line 339 of file MooseTypes.h.

◆ VectorVariablePhiDivergence

Definition at line 340 of file MooseTypes.h.

◆ VectorVariablePhiGradient

Definition at line 337 of file MooseTypes.h.

◆ VectorVariablePhiSecond

Definition at line 338 of file MooseTypes.h.

◆ VectorVariablePhiValue

Definition at line 336 of file MooseTypes.h.

◆ VectorVariableSecond

Definition at line 333 of file MooseTypes.h.

◆ VectorVariableTestCurl

Definition at line 344 of file MooseTypes.h.

◆ VectorVariableTestDivergence

Definition at line 345 of file MooseTypes.h.

◆ VectorVariableTestGradient

Definition at line 342 of file MooseTypes.h.

◆ VectorVariableTestSecond

Definition at line 343 of file MooseTypes.h.

◆ VectorVariableTestValue

Definition at line 341 of file MooseTypes.h.

◆ VectorVariableValue

Definition at line 331 of file MooseTypes.h.

Function Documentation

◆ _MooseIndex() [1/3]

template<typename T , typename std::enable_if< std::is_integral< T >::value >::type * = nullptr>
std::remove_const<T>::type _MooseIndex ( ,
int   
)

Definition at line 113 of file MooseTypes.h.

114 {
115 }

◆ _MooseIndex() [2/3]

template<typename T >
decltype(std::declval<T>().size()) _MooseIndex ( T &&  ,
int   
)

Definition at line 119 of file MooseTypes.h.

120 {
121 }

◆ _MooseIndex() [3/3]

template<typename T >
decltype("NOTE: MooseIndex only works with integers and objects with size()!") _MooseIndex ( ,
double   
)
delete

◆ DerivativeStringClass() [1/46]

DerivativeStringClass ( FileName  )

This type is for expected (i.e.

input) file names or paths that your simulation needs. If relative types are assigned to this type, they are replaced with an absolute path that is relative to the context of the parameter (usually the input file).

◆ DerivativeStringClass() [2/46]

DerivativeStringClass ( FileNameNoExtension  )

Similar to FileName but without an extension.

◆ DerivativeStringClass() [3/46]

DerivativeStringClass ( RelativeFileName  )

This type is for expected filenames that should be relative and will not have their values set to absolute paths like FileName.

◆ DerivativeStringClass() [4/46]

DerivativeStringClass ( DataFileName  )

This type is for files used in the DataFileInterface, which enables searching of files within the registered data directory.

◆ DerivativeStringClass() [5/46]

DerivativeStringClass ( MeshFileName  )

This type is similar to "FileName", but is used to further filter file dialogs on known file mesh types.

◆ DerivativeStringClass() [6/46]

DerivativeStringClass ( MatrixFileName  )

This type is similar to "FileName", but is used to further filter file dialogs on known matrix file types.

◆ DerivativeStringClass() [7/46]

DerivativeStringClass ( OutFileBase  )

This type is for output file base.

◆ DerivativeStringClass() [8/46]

DerivativeStringClass ( NonlinearVariableName  )

This type is used for objects that expect nonlinear variable names (i.e. Kernels, BCs)

◆ DerivativeStringClass() [9/46]

DerivativeStringClass ( LinearVariableName  )

This type is used for objects that expect linear variable names (i.e. LinearFVKernels, LinearFVBCs)

◆ DerivativeStringClass() [10/46]

DerivativeStringClass ( SolverVariableName  )

This type is used for objects that expect linear or nonlinear solver variable names.

◆ DerivativeStringClass() [11/46]

DerivativeStringClass ( AuxVariableName  )

This type is used for objects that expect Auxiliary variable names (i.e. AuxKernels, AuxBCs)

◆ DerivativeStringClass() [12/46]

DerivativeStringClass ( VariableName  )

This type is used for objects that expect either Solver or Auxiliary Variables such as postprocessors.

◆ DerivativeStringClass() [13/46]

DerivativeStringClass ( BoundaryName  )

This type is used for objects that expect Boundary Names/Ids read from or generated on the current mesh.

◆ DerivativeStringClass() [14/46]

DerivativeStringClass ( SubdomainName  )

This type is similar to BoundaryName but is used for "blocks" or subdomains in the current mesh.

◆ DerivativeStringClass() [15/46]

DerivativeStringClass ( PostprocessorName  )

This type is used for objects that expect Postprocessor objects.

◆ DerivativeStringClass() [16/46]

DerivativeStringClass ( VectorPostprocessorName  )

This type is used for objects that expect VectorPostprocessor objects.

◆ DerivativeStringClass() [17/46]

DerivativeStringClass ( MeshDivisionName  )

This type is used for objects that expect MeshDivision objects.

◆ DerivativeStringClass() [18/46]

DerivativeStringClass ( FunctionName  )

This type is used for objects that expect Moose Function objects.

◆ DerivativeStringClass() [19/46]

DerivativeStringClass ( DistributionName  )

This type is used for objects that expect Moose Distribution objects.

◆ DerivativeStringClass() [20/46]

DerivativeStringClass ( SamplerName  )

This type is used for objects that expect Moose Sampler objects.

◆ DerivativeStringClass() [21/46]

DerivativeStringClass ( UserObjectName  )

This type is used for objects that expect "UserObject" names.

◆ DerivativeStringClass() [22/46]

DerivativeStringClass ( IndicatorName  )

This type is used for objects that expect an Indicator object name.

◆ DerivativeStringClass() [23/46]

DerivativeStringClass ( MarkerName  )

This type is used for objects that expect an Marker object name.

◆ DerivativeStringClass() [24/46]

DerivativeStringClass ( MultiAppName  )

This type is used for objects that expect an MultiApp object name.

◆ DerivativeStringClass() [25/46]

DerivativeStringClass ( OutputName  )

Used for objects the require Output object names.

◆ DerivativeStringClass() [26/46]

DerivativeStringClass ( MaterialPropertyName  )

Used for objects that expect MaterialProperty names.

◆ DerivativeStringClass() [27/46]

DerivativeStringClass ( MooseFunctorName  )

Used for objects that expect Moose::Functor names.

◆ DerivativeStringClass() [28/46]

DerivativeStringClass ( MaterialName  )

User for accessing Material objects.

◆ DerivativeStringClass() [29/46]

DerivativeStringClass ( TagName  )

Tag Name.

◆ DerivativeStringClass() [30/46]

DerivativeStringClass ( MeshGeneratorName  )

Name of MeshGenerators.

◆ DerivativeStringClass() [31/46]

DerivativeStringClass ( ExtraElementIDName  )

Name of extra element IDs.

◆ DerivativeStringClass() [32/46]

DerivativeStringClass ( ReporterValueName  )

Name of a Reporter Value, second argument to ReporterName (see Reporter.h)

◆ DerivativeStringClass() [33/46]

DerivativeStringClass ( ComponentName  )

Name of a Component object.

◆ DerivativeStringClass() [34/46]

DerivativeStringClass ( PhysicsName  )

Name of a Physics object.

◆ DerivativeStringClass() [35/46]

DerivativeStringClass ( PositionsName  )

Name of a Positions object.

◆ DerivativeStringClass() [36/46]

DerivativeStringClass ( TimesName  )

Name of a Times object.

◆ DerivativeStringClass() [37/46]

DerivativeStringClass ( ExecutorName  )

Name of an Executor. Used for inputs to Executors.

◆ DerivativeStringClass() [38/46]

DerivativeStringClass ( ParsedFunctionExpression  )

ParsedFunction/ParsedMaterial etc. FParser expression.

◆ DerivativeStringClass() [39/46]

DerivativeStringClass ( NonlinearSystemName  )

System name support of multiple nonlinear systems on the same mesh.

◆ DerivativeStringClass() [40/46]

DerivativeStringClass ( ConvergenceName  )

Name of a Convergence object.

◆ DerivativeStringClass() [41/46]

DerivativeStringClass ( LinearSystemName  )

System name support of multiple linear systems on the same mesh.

◆ DerivativeStringClass() [42/46]

DerivativeStringClass ( SolverSystemName  )

Name of a system which either be linear or nonlinear.

◆ DerivativeStringClass() [43/46]

DerivativeStringClass ( CLIArgString  )

Command line argument, specialized to handle quotes in vector arguments.

◆ DerivativeStringClass() [44/46]

DerivativeStringClass ( MFEMScalarCoefficientName  )

Coefficients used in input for MFEM residual objects.

◆ DerivativeStringClass() [45/46]

DerivativeStringClass ( MFEMVectorCoefficientName  )

◆ DerivativeStringClass() [46/46]

DerivativeStringClass ( MFEMMatrixCoefficientName  )