www.mooseframework.org
Classes | Namespaces | Enumerations | Functions
FEProblemBase.h File Reference

Go to the source code of this file.

Classes

class  FEProblemBase
 Specialization of SubProblem for solving nonlinear equations plus auxiliary equations. More...
 

Namespaces

 libMesh
 The following methods are specializations for using the libMesh::Parallel::packed_range_* routines for std::strings.
 

Enumerations

enum  MooseNonlinearConvergenceReason {
  MOOSE_NONLINEAR_ITERATING = 0, MOOSE_CONVERGED_FNORM_ABS = 2, MOOSE_CONVERGED_FNORM_RELATIVE = 3, MOOSE_CONVERGED_SNORM_RELATIVE = 4,
  MOOSE_DIVERGED_FUNCTION_COUNT = -2, MOOSE_DIVERGED_FNORM_NAN = -4, MOOSE_DIVERGED_LINE_SEARCH = -6
}
 
enum  MooseLinearConvergenceReason {
  MOOSE_LINEAR_ITERATING = 0, MOOSE_CONVERGED_RTOL = 2, MOOSE_CONVERGED_ATOL = 3, MOOSE_CONVERGED_ITS = 4,
  MOOSE_DIVERGED_NULL = -2, MOOSE_DIVERGED_NANORINF = -9, MOOSE_DIVERGED_PCSETUP_FAILED = -11
}
 

Functions

template<>
InputParameters validParams< FEProblemBase > ()
 

Enumeration Type Documentation

Enumerator
MOOSE_LINEAR_ITERATING 
MOOSE_CONVERGED_RTOL 
MOOSE_CONVERGED_ATOL 
MOOSE_CONVERGED_ITS 
MOOSE_DIVERGED_NULL 
MOOSE_DIVERGED_NANORINF 
MOOSE_DIVERGED_PCSETUP_FAILED 

Definition at line 106 of file FEProblemBase.h.

107 {
109  // MOOSE_CONVERGED_RTOL_NORMAL = 1,
110  // MOOSE_CONVERGED_ATOL_NORMAL = 9,
114  // MOOSE_CONVERGED_CG_NEG_CURVE = 5,
115  // MOOSE_CONVERGED_CG_CONSTRAINED = 6,
116  // MOOSE_CONVERGED_STEP_LENGTH = 7,
117  // MOOSE_CONVERGED_HAPPY_BREAKDOWN = 8,
118  MOOSE_DIVERGED_NULL = -2,
119  // MOOSE_DIVERGED_ITS = -3,
120  // MOOSE_DIVERGED_DTOL = -4,
121  // MOOSE_DIVERGED_BREAKDOWN = -5,
122  // MOOSE_DIVERGED_BREAKDOWN_BICG = -6,
123  // MOOSE_DIVERGED_NONSYMMETRIC = -7,
124  // MOOSE_DIVERGED_INDEFINITE_PC = -8,
126  // MOOSE_DIVERGED_INDEFINITE_MAT = -10
128 };
Enumerator
MOOSE_NONLINEAR_ITERATING 
MOOSE_CONVERGED_FNORM_ABS 
MOOSE_CONVERGED_FNORM_RELATIVE 
MOOSE_CONVERGED_SNORM_RELATIVE 
MOOSE_DIVERGED_FUNCTION_COUNT 
MOOSE_DIVERGED_FNORM_NAN 
MOOSE_DIVERGED_LINE_SEARCH 

Definition at line 89 of file FEProblemBase.h.

Function Documentation

Definition at line 109 of file FEProblemBase.C.

Referenced by validParams< EigenProblem >(), and validParams< FEProblem >().

110 {
112  params.addPrivateParam<MooseMesh *>("mesh");
113  params.addParam<unsigned int>("null_space_dimension", 0, "The dimension of the nullspace");
114  params.addParam<unsigned int>(
115  "transpose_null_space_dimension", 0, "The dimension of the transpose nullspace");
116  params.addParam<unsigned int>(
117  "near_null_space_dimension", 0, "The dimension of the near nullspace");
118  params.addParam<bool>("solve",
119  true,
120  "Whether or not to actually solve the Nonlinear system. "
121  "This is handy in the case that all you want to do is "
122  "execute AuxKernels, Transfers, etc. without actually "
123  "solving anything");
124  params.addParam<bool>("use_nonlinear",
125  true,
126  "Determines whether to use a Nonlinear vs a "
127  "Eigenvalue system (Automatically determined based "
128  "on executioner)");
129  params.addParam<bool>("error_on_jacobian_nonzero_reallocation",
130  false,
131  "This causes PETSc to error if it had to reallocate memory in the Jacobian "
132  "matrix due to not having enough nonzeros");
133  params.addParam<bool>("ignore_zeros_in_jacobian",
134  false,
135  "Do not explicitly store zero values in "
136  "the Jacobian matrix if true");
137  params.addParam<bool>("force_restart",
138  false,
139  "EXPERIMENTAL: If true, a sub_app may use a "
140  "restart file instead of using of using the master "
141  "backup file");
142  params.addParam<bool>("skip_additional_restart_data",
143  false,
144  "True to skip additional data in equation system for restart. It is useful "
145  "for starting a transient calculation with a steady-state solution");
146 
147  return params;
148 }
void addPrivateParam(const std::string &name, const T &value)
These method add a parameter to the InputParameters object which can be retrieved like any other para...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< SubProblem >()
Definition: SubProblem.C:26
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...