www.mooseframework.org
Namespaces | Typedefs | Enumerations | Functions | Variables
MooseTypes.h File Reference

Go to the source code of this file.

Namespaces

 Moose
 

Typedefs

typedef Real PostprocessorValue
 MOOSE typedefs. More...
 
typedef std::vector< Real > VectorPostprocessorValue
 
typedef boundary_id_type BoundaryID
 
typedef unsigned int InterfaceID
 
typedef subdomain_id_type SubdomainID
 
typedef unsigned int MooseObjectID
 
typedef unsigned int THREAD_ID
 
typedef StoredRange< std::vector< dof_id_type >::iterator, dof_id_type > NodeIdRange
 
typedef StoredRange< std::vector< const Elem * >::iterator, const Elem * > ConstElemPointerRange
 

Enumerations

enum  ExecFlagType {
  EXEC_NONE = 0x00, EXEC_INITIAL = 0x01, EXEC_LINEAR = 0x02, EXEC_NONLINEAR = 0x04,
  EXEC_TIMESTEP_END = 0x08, EXEC_TIMESTEP_BEGIN = 0x10, EXEC_FINAL = 0x20, EXEC_FORCED = 0x40,
  EXEC_FAILED = 0x80, EXEC_CUSTOM = 0x100, EXEC_SUBDOMAIN = 0x200
}
 Execution flags - when is the object executed/evaluated. More...
 
enum  Moose::MaterialDataType { Moose::BLOCK_MATERIAL_DATA, Moose::BOUNDARY_MATERIAL_DATA, Moose::FACE_MATERIAL_DATA, Moose::NEIGHBOR_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 exeuction type. More...
 
enum  Moose::VarKindType { Moose::VAR_NONLINEAR, Moose::VAR_AUXILIARY }
 Framework-wide stuff. More...
 
enum  Moose::KernelType {
  Moose::KT_TIME = 0, Moose::KT_NONTIME = 1, Moose::KT_NONEIGEN = 2, Moose::KT_EIGEN = 3,
  Moose::KT_ALL
}
 
enum  Moose::CouplingType { Moose::COUPLING_DIAG, Moose::COUPLING_FULL, Moose::COUPLING_CUSTOM }
 
enum  Moose::ConstraintSideType { Moose::SIDE_MASTER, Moose::SIDE_SLAVE }
 
enum  Moose::DGResidualType { Moose::Element, Moose::Neighbor }
 
enum  Moose::DGJacobianType { Moose::ElementElement, Moose::ElementNeighbor, Moose::NeighborElement, Moose::NeighborNeighbor }
 
enum  Moose::ConstraintType { Moose::Slave = Element, Moose::Master = Neighbor }
 
enum  Moose::ConstraintJacobianType { Moose::SlaveSlave = ElementElement, Moose::SlaveMaster = ElementNeighbor, Moose::MasterSlave = NeighborElement, Moose::MasterMaster = NeighborNeighbor }
 
enum  Moose::CoordinateSystemType { Moose::COORD_XYZ, 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_MF_NONLINEAR_POWER, Moose::EST_MONOLITH_NEWTON, Moose::EST_MF_MONOLITH_NEWTON
}
 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
}
 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_CUBIC, Moose::LS_QUADRATIC, Moose::LS_BASICNONORMS, Moose::LS_SHELL,
  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...
 

Functions

 DerivativeStringClass (FileName)
 This type is for expected (i.e. More...
 
 DerivativeStringClass (FileNameNoExtension)
 This type is for expected filenames where the extension is unwanted, it can be used to trigger open file dialogs in the GUI. More...
 
 DerivativeStringClass (MeshFileName)
 This type is similar to "FileName", but is used to further filter file dialogs on known file mesh 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 (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 Nonlinear 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 (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 (MaterialName)
 User for accessing Material objects. More...
 

Variables

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 std::set< SubdomainIDMoose::EMPTY_BLOCK_IDS = {}
 
const std::set< BoundaryIDMoose::EMPTY_BOUNDARY_IDS = {}
 
const std::vector< ExecFlagTypeMoose::exec_types = populateExecTypes()
 A static list of all the exec types. More...
 

Typedef Documentation

typedef boundary_id_type BoundaryID

Definition at line 75 of file MooseTypes.h.

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

Definition at line 82 of file MooseTypes.h.

typedef unsigned int InterfaceID

Definition at line 76 of file MooseTypes.h.

typedef unsigned int MooseObjectID

Definition at line 78 of file MooseTypes.h.

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

Definition at line 81 of file MooseTypes.h.

typedef Real PostprocessorValue

MOOSE typedefs.

Definition at line 73 of file MooseTypes.h.

typedef subdomain_id_type SubdomainID

Definition at line 77 of file MooseTypes.h.

typedef unsigned int THREAD_ID

Definition at line 79 of file MooseTypes.h.

typedef std::vector<Real> VectorPostprocessorValue

Definition at line 74 of file MooseTypes.h.

Enumeration Type Documentation

Execution flags - when is the object executed/evaluated.

Enumerator
EXEC_NONE 
EXEC_INITIAL 

Object is evaluated only once at the beginning of the simulation.

EXEC_LINEAR 

Object is evaluated in every residual computation.

EXEC_NONLINEAR 

Object is evaluated in every jacobian computation.

EXEC_TIMESTEP_END 

Object is evaluated at the end of every time step.

EXEC_TIMESTEP_BEGIN 

Object is evaluated at the beginning of every time step.

EXEC_FINAL 

Object is evaluated at the end of the simulations (output only)

EXEC_FORCED 

Forces execution to occur (output only)

EXEC_FAILED 

Forces execution on failed solve (output only)

EXEC_CUSTOM 

For use with custom executioners that want to fire objects at a specific time.

EXEC_SUBDOMAIN 

Objects is evaluated on subdomain.

Definition at line 90 of file MooseTypes.h.

91 {
92  EXEC_NONE = 0x00, // 0
94  EXEC_INITIAL = 0x01, // 1
96  EXEC_LINEAR = 0x02, // 2
98  EXEC_NONLINEAR = 0x04, // 4
100  EXEC_TIMESTEP_END = 0x08, // 8
102  EXEC_TIMESTEP_BEGIN = 0x10, // 16
104  EXEC_FINAL = 0x20, // 32
106  EXEC_FORCED = 0x40, // 64
108  EXEC_FAILED = 0x80, // 128
110  EXEC_CUSTOM = 0x100, // 256
112  EXEC_SUBDOMAIN = 0x200 // 512
113 };
Object is evaluated in every residual computation.
Definition: MooseTypes.h:96
For use with custom executioners that want to fire objects at a specific time.
Definition: MooseTypes.h:110
Object is evaluated only once at the beginning of the simulation.
Definition: MooseTypes.h:94
Object is evaluated at the end of every time step.
Definition: MooseTypes.h:100
Forces execution to occur (output only)
Definition: MooseTypes.h:106
Objects is evaluated on subdomain.
Definition: MooseTypes.h:112
Forces execution on failed solve (output only)
Definition: MooseTypes.h:108
Object is evaluated at the end of the simulations (output only)
Definition: MooseTypes.h:104
Object is evaluated at the beginning of every time step.
Definition: MooseTypes.h:102
Object is evaluated in every jacobian computation.
Definition: MooseTypes.h:98

Function Documentation

DerivativeStringClass ( FileName  )

This type is for expected (i.e.

input) file names or paths that your simulation needs. If relative paths are assigned to this type, they are treated/modified to be relative to the location of the simulation's main input file's directory. It can be used to trigger open file dialogs in the GUI.

DerivativeStringClass ( FileNameNoExtension  )

This type is for expected filenames where the extension is unwanted, it can be used to trigger open file dialogs in the GUI.

DerivativeStringClass ( MeshFileName  )

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

DerivativeStringClass ( OutFileBase  )

This type is for output file base.

DerivativeStringClass ( NonlinearVariableName  )

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

DerivativeStringClass ( AuxVariableName  )

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

DerivativeStringClass ( VariableName  )

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

DerivativeStringClass ( BoundaryName  )

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

DerivativeStringClass ( SubdomainName  )

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

DerivativeStringClass ( PostprocessorName  )

This type is used for objects that expect Postprocessor objects.

DerivativeStringClass ( VectorPostprocessorName  )

This type is used for objects that expect VectorPostprocessor objects.

DerivativeStringClass ( FunctionName  )

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

DerivativeStringClass ( DistributionName  )

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

DerivativeStringClass ( SamplerName  )

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

DerivativeStringClass ( UserObjectName  )

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

DerivativeStringClass ( IndicatorName  )

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

DerivativeStringClass ( MarkerName  )

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

DerivativeStringClass ( MultiAppName  )

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

DerivativeStringClass ( OutputName  )

Used for objects the require Output object names.

DerivativeStringClass ( MaterialPropertyName  )

Used for objects that expect MaterialProperty names.

DerivativeStringClass ( MaterialName  )

User for accessing Material objects.