120 #include "libmesh/exodusII_io.h" 121 #include "libmesh/quadrature.h" 122 #include "libmesh/coupling_matrix.h" 123 #include "libmesh/nonlinear_solver.h" 124 #include "libmesh/sparse_matrix.h" 125 #include "libmesh/string_to_enum.h" 126 #include "libmesh/fe_interface.h" 127 #include "libmesh/enum_norm_type.h" 128 #include "libmesh/petsc_solver_exception.h" 130 #include "metaphysicl/dualnumber.h" 153 params.
addParam<
unsigned int>(
"null_space_dimension", 0,
"The dimension of the nullspace");
155 "transpose_null_space_dimension", 0,
"The dimension of the transpose nullspace");
157 "near_null_space_dimension", 0,
"The dimension of the near nullspace");
160 "Whether or not to actually solve the Nonlinear system. " 161 "This is handy in the case that all you want to do is " 162 "execute AuxKernels, Transfers, etc. without actually " 164 params.
addParam<
bool>(
"use_nonlinear",
166 "Determines whether to use a Nonlinear vs a " 167 "Eigenvalue system (Automatically determined based " 169 params.
addParam<
bool>(
"error_on_jacobian_nonzero_reallocation",
170 "This causes PETSc to error if it had to reallocate memory in the Jacobian " 171 "matrix due to not having enough nonzeros");
172 params.
addParam<
bool>(
"ignore_zeros_in_jacobian",
174 "Do not explicitly store zero values in " 175 "the Jacobian matrix if true");
176 params.
addParam<
bool>(
"force_restart",
178 "EXPERIMENTAL: If true, a sub_app may use a " 179 "restart file instead of using of using the master " 183 "True to skip additional data in equation system for restart.",
184 "This parameter is no longer used, as we do not load additional " 185 "vectors by default with restart");
186 params.
addParam<
bool>(
"skip_nl_system_check",
188 "True to skip the NonlinearSystem check for work to do (e.g. Make sure " 189 "that there are variables to solve for).");
190 params.
addParam<
bool>(
"allow_initial_conditions_with_restart",
192 "True to allow the user to specify initial conditions when restarting. " 193 "Initial conditions can override any restarted field");
195 auto coverage_check_description = [](std::string scope, std::string list_param_name)
197 return "Controls, if and how a " + scope +
198 " subdomain coverage check is performed. " 199 "With 'TRUE' or 'ON' all subdomains are checked (the default). Setting 'FALSE' or 'OFF' " 200 "will disable the check for all subdomains. " 201 "To exclude a predefined set of subdomains 'SKIP_LIST' is to " 202 "be used, while the subdomains to skip are to be defined in the parameter '" +
204 "'. To limit the check to a list of subdomains, 'ONLY_LIST' is to " 205 "be used (again, using the parameter '" +
206 list_param_name +
"').";
209 params.
addParam<std::vector<SubdomainName>>(
212 "List of subdomains for kernel coverage and material coverage checks. Setting this parameter " 213 "is equivalent to setting 'kernel_coverage_block_list' and 'material_coverage_block_list' as " 214 "well as using 'ONLY_LIST' as the coverage check mode.");
216 MooseEnum kernel_coverage_check_modes(
"FALSE TRUE OFF ON SKIP_LIST ONLY_LIST",
"TRUE");
218 kernel_coverage_check_modes,
219 coverage_check_description(
"kernel",
"kernel_coverage_block_list"));
220 params.
addParam<std::vector<SubdomainName>>(
221 "kernel_coverage_block_list",
223 "List of subdomains for kernel coverage check. The meaning of this list is controlled by the " 224 "parameter 'kernel_coverage_check' (whether this is the list of subdomains to be checked, " 225 "not to be checked or not taken into account).");
227 "boundary_restricted_node_integrity_check",
229 "Set to false to disable checking of boundary restricted nodal object variable dependencies, " 230 "e.g. are the variable dependencies defined on the selected boundaries?");
231 params.
addParam<
bool>(
"boundary_restricted_elem_integrity_check",
233 "Set to false to disable checking of boundary restricted elemental object " 234 "variable dependencies, e.g. are the variable dependencies defined on the " 235 "selected boundaries?");
236 MooseEnum material_coverage_check_modes(
"FALSE TRUE OFF ON SKIP_LIST ONLY_LIST",
"TRUE");
238 "material_coverage_check",
239 material_coverage_check_modes,
240 coverage_check_description(
"material",
"material_coverage_block_list"));
241 params.
addParam<std::vector<SubdomainName>>(
242 "material_coverage_block_list",
244 "List of subdomains for material coverage check. The meaning of this list is controlled by " 245 "the parameter 'material_coverage_check' (whether this is the list of subdomains to be " 246 "checked, not to be checked or not taken into account).");
248 params.
addParam<
bool>(
"fv_bcs_integrity_check",
250 "Set to false to disable checking of overlapping Dirichlet and Flux BCs " 251 "and/or multiple DirichletBCs per sideset");
254 "material_dependency_check",
true,
"Set to false to disable material dependency check");
255 params.
addParam<
bool>(
"parallel_barrier_messaging",
257 "Displays messaging from parallel " 258 "barrier notifications when executing " 259 "or transferring to/from Multiapps " 262 MooseEnum verbosity(
"false true extra",
"false");
265 "Set to 'true' to have the problem report on any object created. Set " 266 "to 'extra' to also display all parameters.");
267 params.
addParam<
bool>(
"verbose_multiapps",
269 "Set to True to enable verbose screen printing related to MultiApps");
273 "Set to True to enable verbose screen printing related to solution restoration");
275 params.
addParam<FileNameNoExtension>(
"restart_file_base",
276 "File base name used for restart (e.g. " 277 "<path>/<filebase> or <path>/LATEST to " 278 "grab the latest file available)");
280 params.
addParam<std::vector<std::vector<TagName>>>(
283 "Extra vectors to add to the system that can be filled by objects which compute residuals " 284 "and Jacobians (Kernels, BCs, etc.) by setting tags on them. The outer index is for which " 285 "nonlinear system the extra tag vectors should be added for");
287 params.
addParam<std::vector<std::vector<TagName>>>(
288 "not_zeroed_tag_vectors",
290 "Extra vector tags which the sytem will not zero when other vector tags are zeroed. " 291 "The outer index is for which nonlinear system the extra tag vectors should be added for");
293 params.
addParam<std::vector<std::vector<TagName>>>(
294 "extra_tag_matrices",
296 "Extra matrices to add to the system that can be filled " 297 "by objects which compute residuals and Jacobians " 298 "(Kernels, BCs, etc.) by setting tags on them. The outer index is for which " 299 "nonlinear system the extra tag vectors should be added for");
301 params.
addParam<std::vector<TagName>>(
302 "extra_tag_solutions",
304 "Extra solution vectors to add to the system that can be used by " 305 "objects for coupling variable values stored in them.");
307 params.
addParam<
bool>(
"previous_nl_solution_required",
309 "True to indicate that this calculation requires a solution vector for " 310 "storing the previous nonlinear iteration.");
312 params.
addParam<std::vector<NonlinearSystemName>>(
313 "nl_sys_names", std::vector<NonlinearSystemName>{
"nl0"},
"The nonlinear system names");
315 params.
addParam<std::vector<LinearSystemName>>(
"linear_sys_names", {},
"The linear system names");
317 params.
addParam<
bool>(
"check_uo_aux_state",
319 "True to turn on a check that no state presents during the evaluation of " 320 "user objects and aux kernels");
327 "allow_invalid_solution",
329 "Set to true to allow convergence even though the solution has been marked as 'invalid'");
330 params.
addParam<
bool>(
"show_invalid_solution_console",
332 "Set to true to show the invalid solution occurance summary in console");
333 params.
addParam<
bool>(
"immediately_print_invalid_solution",
335 "Whether or not to report invalid solution warnings at the time the " 336 "warning is produced instead of after the calculation");
339 "identify_variable_groups_in_nl",
341 "Whether to identify variable groups in nonlinear systems. This affects dof ordering");
344 "regard_general_exceptions_as_errors",
346 "If we catch an exception during residual/Jacobian evaluaton for which we don't have " 347 "specific handling, immediately error instead of allowing the time step to be cut");
349 params.
addParam<
bool>(
"use_hash_table_matrix_assembly",
351 "Whether to assemble matrices using hash tables instead of preallocating " 352 "matrix memory. This can be a good option if the sparsity pattern changes " 353 "throughout the course of the simulation.");
355 "restore_original_nonzero_pattern",
356 "Whether we should reset matrix memory for every Jacobian evaluation. This option is useful " 357 "if the sparsity pattern is constantly changing and you are using hash table assembly or if " 358 "you wish to continually restore the matrix to the originally preallocated sparsity pattern " 359 "computed by relationship managers.");
362 "skip_nl_system_check kernel_coverage_check kernel_coverage_block_list " 363 "boundary_restricted_node_integrity_check " 364 "boundary_restricted_elem_integrity_check material_coverage_check " 365 "material_coverage_block_list fv_bcs_integrity_check " 366 "material_dependency_check check_uo_aux_state error_on_jacobian_nonzero_reallocation",
367 "Simulation checks");
369 "ignore_zeros_in_jacobian identify_variable_groups_in_nl " 370 "use_hash_table_matrix_assembly restore_original_nonzero_pattern",
371 "Nonlinear system(s)");
373 "restart_file_base force_restart allow_initial_conditions_with_restart",
"Restart");
375 "verbose_setup verbose_multiapps verbose_restore parallel_barrier_messaging",
"Verbosity");
377 "null_space_dimension transpose_null_space_dimension near_null_space_dimension",
378 "Null space removal");
380 "extra_tag_vectors extra_tag_matrices extra_tag_solutions not_zeroed_tag_vectors",
381 "Contribution to tagged field data");
383 "allow_invalid_solution show_invalid_solution_console immediately_print_invalid_solution",
384 "Solution validity control");
392 _mesh(*getCheckedPointerParam<
MooseMesh *>(
"mesh")),
394 "equation_systems", nullptr, _mesh)),
396 _solve(getParam<bool>(
"solve")),
398 _time(declareRestartableData<
Real>(
"time")),
399 _time_old(declareRestartableData<
Real>(
"time_old")),
400 _t_step(declareRecoverableData<
int>(
"t_step")),
401 _dt(declareRestartableData<
Real>(
"dt")),
402 _dt_old(declareRestartableData<
Real>(
"dt_old")),
403 _need_to_add_default_nonlinear_convergence(false),
404 _need_to_add_default_multiapp_fixed_point_convergence(false),
405 _need_to_add_default_steady_state_convergence(false),
406 _linear_sys_names(getParam<
std::vector<LinearSystemName>>(
"linear_sys_names")),
407 _num_linear_sys(_linear_sys_names.size()),
408 _linear_systems(_num_linear_sys, nullptr),
409 _current_linear_sys(nullptr),
410 _using_default_nl(!isParamSetByUser(
"nl_sys_names")),
411 _nl_sys_names(!_using_default_nl || (_using_default_nl && !_linear_sys_names.size())
412 ? getParam<
std::vector<NonlinearSystemName>>(
"nl_sys_names")
413 :
std::vector<NonlinearSystemName>()),
414 _num_nl_sys(_nl_sys_names.size()),
415 _nl(_num_nl_sys, nullptr),
416 _current_nl_sys(nullptr),
417 _solver_systems(_num_nl_sys + _num_linear_sys, nullptr),
420 _mesh_divisions(true),
422 "material_props", &_mesh, _material_prop_registry)),
424 "bnd_material_props", &_mesh, _material_prop_registry)),
426 "neighbor_material_props", &_mesh, _material_prop_registry)),
427 _reporter_data(_app),
429 _all_user_objects(_app.getExecuteOnEnum()),
430 _multi_apps(_app.getExecuteOnEnum()),
431 _transient_multi_apps(_app.getExecuteOnEnum()),
432 _transfers(_app.getExecuteOnEnum(), false),
433 _to_multi_app_transfers(_app.getExecuteOnEnum(), false),
434 _from_multi_app_transfers(_app.getExecuteOnEnum(), false),
435 _between_multi_app_transfers(_app.getExecuteOnEnum(), false),
436 #ifdef LIBMESH_ENABLE_AMR
438 _cycles_completed(0),
440 _displaced_mesh(nullptr),
441 _geometric_search_data(*this, _mesh),
443 _reinit_displaced_elem(false),
444 _reinit_displaced_face(false),
445 _reinit_displaced_neighbor(false),
446 _input_file_saved(false),
448 _has_constraints(false),
449 _snesmf_reuse_base(true),
450 _skip_exception_check(false),
451 _snesmf_reuse_base_set_by_user(false),
452 _has_initialized_stateful(false),
453 _const_jacobian(false),
454 _has_jacobian(false),
455 _needs_old_newton_iter(false),
456 _previous_nl_solution_required(getParam<bool>(
"previous_nl_solution_required")),
457 _has_nonlocal_coupling(false),
458 _calculate_jacobian_in_uo(false),
459 _kernel_coverage_check(
461 _kernel_coverage_blocks(getParam<
std::vector<SubdomainName>>(
"kernel_coverage_block_list")),
462 _boundary_restricted_node_integrity_check(
463 getParam<bool>(
"boundary_restricted_node_integrity_check")),
464 _boundary_restricted_elem_integrity_check(
465 getParam<bool>(
"boundary_restricted_elem_integrity_check")),
466 _material_coverage_check(
468 _material_coverage_blocks(getParam<
std::vector<SubdomainName>>(
"material_coverage_block_list")),
469 _fv_bcs_integrity_check(getParam<bool>(
"fv_bcs_integrity_check")),
470 _material_dependency_check(getParam<bool>(
"material_dependency_check")),
471 _uo_aux_state_check(getParam<bool>(
"check_uo_aux_state")),
472 _max_qps(
std::numeric_limits<unsigned
int>::
max()),
474 _has_time_integrator(false),
475 _has_exception(false),
476 _parallel_barrier_messaging(getParam<bool>(
"parallel_barrier_messaging")),
477 _verbose_setup(getParam<
MooseEnum>(
"verbose_setup")),
478 _verbose_multiapps(getParam<bool>(
"verbose_multiapps")),
479 _verbose_restore(getParam<bool>(
"verbose_restore")),
481 _control_warehouse(_app.getExecuteOnEnum(), false),
482 _is_petsc_options_inserted(false),
483 _line_search(nullptr),
484 _using_ad_mat_props(false),
485 _current_ic_state(0),
486 _use_hash_table_matrix_assembly(getParam<bool>(
"use_hash_table_matrix_assembly")),
487 _error_on_jacobian_nonzero_reallocation(
488 isParamValid(
"error_on_jacobian_nonzero_reallocation")
489 ? getParam<bool>(
"error_on_jacobian_nonzero_reallocation")
490 : _app.errorOnJacobianNonzeroReallocation()),
491 _restore_original_nonzero_pattern(isParamValid(
"restore_original_nonzero_pattern")
492 ? getParam<bool>(
"restore_original_nonzero_pattern")
493 : _use_hash_table_matrix_assembly),
494 _ignore_zeros_in_jacobian(getParam<bool>(
"ignore_zeros_in_jacobian")),
495 _preserve_matrix_sparsity_pattern(true),
496 _force_restart(getParam<bool>(
"force_restart")),
497 _allow_ics_during_restart(getParam<bool>(
"allow_initial_conditions_with_restart")),
498 _skip_nl_system_check(getParam<bool>(
"skip_nl_system_check")),
499 _fail_next_system_convergence_check(false),
500 _allow_invalid_solution(getParam<bool>(
"allow_invalid_solution")),
501 _show_invalid_solution_console(getParam<bool>(
"show_invalid_solution_console")),
502 _immediately_print_invalid_solution(getParam<bool>(
"immediately_print_invalid_solution")),
503 _started_initial_setup(false),
504 _has_internal_edge_residual_objects(false),
505 _u_dot_requested(false),
506 _u_dotdot_requested(false),
507 _u_dot_old_requested(false),
508 _u_dotdot_old_requested(false),
511 _print_execution_on(),
512 _identify_variable_groups_in_nl(getParam<bool>(
"identify_variable_groups_in_nl")),
513 _regard_general_exceptions_as_errors(getParam<bool>(
"regard_general_exceptions_as_errors")),
514 _requires_nonlocal_coupling(false)
516 auto checkCoverageCheckConflict =
517 [
this](
const std::string & coverage_check,
519 const std::vector<SubdomainName> & coverage_blocks) ->
void 523 if (coverage_blocks.size() > 1)
524 if (std::find(coverage_blocks.begin(), coverage_blocks.end(),
"ANY_BLOCK_ID") !=
525 coverage_blocks.end())
527 "The list of blocks used for ",
529 " cannot contain 'ANY_BLOCK_ID' along with other blocks. ");
532 checkCoverageCheckConflict(
534 checkCoverageCheckConflict(
540 ADReal::do_derivatives =
true;
604 std::string restart_file_base = getParam<FileNameNoExtension>(
"restart_file_base");
611 if (restart_file_base.size())
629 #if !PETSC_RELEASE_LESS_THAN(3, 12, 0) 648 mooseWarning(
"Displaced mesh was requested but the displaced problem does not exist. " 649 "Regular mesh will be returned");
657 auto & vectors = getParam<std::vector<std::vector<TagName>>>(
"extra_tag_vectors");
659 for (
auto & vector : vectors[sys_num])
665 auto & not_zeroed_vectors = getParam<std::vector<std::vector<TagName>>>(
"not_zeroed_tag_vectors");
666 for (
const auto sys_num :
index_range(not_zeroed_vectors))
667 for (
auto & vector : not_zeroed_vectors[sys_num])
675 auto & matrices = getParam<std::vector<std::vector<TagName>>>(
"extra_tag_matrices");
677 for (
auto & matrix : matrices[sys_num])
687 for (
auto & vector :
getParam<std::vector<TagName>>(
"extra_tag_solutions"))
706 sys->associateVectorToTag(*sys->system().current_local_solution.get(), tag);
707 _aux->associateVectorToTag(*
_aux->system().current_local_solution.get(), tag);
714 for (
const auto i :
make_range((
unsigned)0, oldest_needed))
717 sys->needSolutionState(i, iteration_type);
718 _aux->needSolutionState(i, iteration_type);
730 _assembly[i].resize(solver_systems.size());
732 _assembly[i][j] = std::make_unique<Assembly>(*solver_systems[j], i);
738 std::vector<std::shared_ptr<NonlinearSystemBase>> & nls)
740 TIME_SECTION(
"initNullSpaceVectors", 5,
"Initializing Null Space Vectors");
742 unsigned int dimNullSpace =
parameters.
get<
unsigned int>(
"null_space_dimension");
743 unsigned int dimTransposeNullSpace =
744 parameters.
get<
unsigned int>(
"transpose_null_space_dimension");
745 unsigned int dimNearNullSpace =
parameters.
get<
unsigned int>(
"near_null_space_dimension");
746 for (
unsigned int i = 0; i < dimNullSpace; ++i)
748 std::ostringstream oss;
752 for (
auto & nl : nls)
756 for (
unsigned int i = 0; i < dimTransposeNullSpace; ++i)
758 std::ostringstream oss;
762 for (
auto & nl : nls)
766 for (
unsigned int i = 0; i < dimNearNullSpace; ++i)
768 std::ostringstream oss;
772 for (
auto & nl : nls)
787 for (
unsigned int i = 0; i <
n_threads; i++)
803 #if !PETSC_RELEASE_LESS_THAN(3, 12, 0) 808 CHKERRABORT(this->
comm().
get(), ierr);
817 TIME_SECTION(
"setCoordSystem", 5,
"Setting Coordinate System");
832 std::vector<const DofMap *> dof_maps(
es().n_systems());
836 dof_maps[i] = &sys.get_dof_map();
839 std::make_unique<ConstElemRange>(
_mesh.
getMesh().multi_evaluable_elements_begin(dof_maps),
840 _mesh.
getMesh().multi_evaluable_elements_end(dof_maps));
850 std::vector<const DofMap *> dof_maps(
_nl.size());
852 dof_maps[i] = &
_nl[i]->dofMap();
854 std::make_unique<ConstElemRange>(
_mesh.
getMesh().multi_evaluable_elements_begin(dof_maps),
855 _mesh.
getMesh().multi_evaluable_elements_end(dof_maps));
864 TIME_SECTION(
"initialSetup", 2,
"Performing Initial Setup");
869 mooseError(
"Checkpoint recovery and restart and exodus restart are all mutually exclusive.");
872 mooseWarning(
"MOOSE may fail to catch an exception when the \"skip_exception_check\" parameter " 873 "is used. If you receive a terse MPI error during execution, remove this " 874 "parameter and rerun your simulation");
889 _aux->initSolutionState();
902 TIME_SECTION(
"computingMaxDofs", 3,
"Computing Max Dofs Per Element");
906 max_var_n_dofs_per_elem = mvndpe.
max();
911 max_var_n_dofs_per_node = mvndpn.
max();
913 global_max_var_n_dofs_per_elem =
914 std::max(global_max_var_n_dofs_per_elem, max_var_n_dofs_per_elem);
918 TIME_SECTION(
"assignMaxDofs", 5,
"Assigning Maximum Dofs Per Elem");
920 sys.assignMaxVarNDofsPerElem(max_var_n_dofs_per_elem);
923 displaced_problem->solverSys(i).assignMaxVarNDofsPerElem(max_var_n_dofs_per_elem);
925 sys.assignMaxVarNDofsPerNode(max_var_n_dofs_per_node);
927 displaced_problem->solverSys(i).assignMaxVarNDofsPerNode(max_var_n_dofs_per_node);
932 TIME_SECTION(
"resizingVarValues", 5,
"Resizing Variable Values");
936 _phi_zero[tid].resize(global_max_var_n_dofs_per_elem, std::vector<Real>(
getMaxQps(), 0.));
956 props->setRecovering();
958 TIME_SECTION(
"restore", 3,
"Restoring from backup");
985 TIME_SECTION(
"copyingFromExodus", 3,
"Copying Variables From Exodus");
988 sys->copyVars(*reader);
989 _aux->copyVars(*reader);
994 mooseError(
"Need Exodus reader to restart variables but the reader is not available\n" 995 "Use either FileMesh with an Exodus mesh file or FileMeshGenerator with an " 996 "Exodus mesh file and with use_for_exodus_restart equal to true");
1012 mooseError(
"Stateful neighbor material properties do not work with mesh adaptivity");
1028 "Doing extra refinements when restarting is NOT supported for sub-apps of a MultiApp");
1038 TIME_SECTION(
"convergenceInitialSetup", 5,
"Initializing Convergence objects");
1046 std::set<std::string> depend_objects_aux =
_aux->getDependObjects();
1050 std::vector<UserObject *> userobjs;
1055 std::map<int, std::vector<UserObject *>> group_userobjs;
1056 for (
auto obj : userobjs)
1057 group_userobjs[obj->getParam<
int>(
"execution_order_group")].push_back(obj);
1059 for (
auto & [group, objs] : group_userobjs)
1060 for (
auto obj : objs)
1061 obj->initialSetup();
1073 TIME_SECTION(
"initializingFunctions", 5,
"Initializing Functions");
1085 TIME_SECTION(
"initializingRandomObjects", 5,
"Initializing Random Objects");
1097 TIME_SECTION(
"ICinitialSetup", 5,
"Setting Up Initial Conditions");
1111 TIME_SECTION(
"materialInitialSetup", 3,
"Setting Up Materials");
1133 TIME_SECTION(
"computingInitialStatefulProps", 3,
"Computing Initial Material Values");
1149 props->setRestartInPlace();
1150 props->setRecovering();
1161 #ifdef LIBMESH_ENABLE_AMR 1167 mooseError(
"Cannot perform initial adaptivity during restart on sub-apps of a MultiApp!");
1172 #endif // LIBMESH_ENABLE_AMR 1183 unsigned short ic_state_max = 0;
1185 auto findMax = [&ic_state_max](
const auto & obj_list)
1187 for (
auto ic : obj_list.getActiveObjects())
1188 ic_state_max =
std::max(ic_state_max, ic->getState());
1195 if (ic_state_max > 0)
1199 std::vector<std::unique_ptr<NumericVector<Real>>> state0_sys_buffers(
_solver_systems.size());
1200 std::unique_ptr<NumericVector<Real>> state0_aux_buffer;
1206 state0_aux_buffer =
_aux->solutionState(0).clone();
1227 _aux->solutionState(0) = *state0_aux_buffer;
1228 _aux->solutionState(0).close();
1241 sys->initialSetup();
1244 _aux->initialSetup();
1251 sys->setSolution(*(sys->system().current_local_solution.get()));
1281 const auto & tis = sys->getTimeIntegrators();
1284 TIME_SECTION(
"timeIntegratorInitialSetup", 5,
"Initializing Time Integrator");
1285 for (
auto & ti : tis)
1296 TIME_SECTION(
"initialSetupMultiApps", 2,
"Initializing MultiApps",
false);
1302 TIME_SECTION(
"initialSetupTransfers", 2,
"Initializing Transfers");
1308 for (
const auto & transfer : to_multi_app_objects)
1310 transfer->setCurrentDirection(Transfer::DIRECTION::TO_MULTIAPP);
1311 transfer->initialSetup();
1316 for (
const auto & transfer : from_multi_app_objects)
1318 transfer->setCurrentDirection(Transfer::DIRECTION::FROM_MULTIAPP);
1319 transfer->initialSetup();
1324 for (
const auto & transfer : between_multi_app_objects)
1326 transfer->setCurrentDirection(Transfer::DIRECTION::BETWEEN_MULTIAPP);
1327 transfer->initialSetup();
1333 TIME_SECTION(
"BoundaryRestrictedNodeIntegrityCheck", 5);
1338 Threads::parallel_reduce(bnd_nodes, bnict);
1342 for (
const auto & bnode : bnd_nodes)
1344 const auto boundary_id = bnode->_bnd_id;
1345 const Node *
const node = bnode->_node;
1352 const Elem *
const an_elem =
1359 for (
auto & nl :
_nl)
1361 const auto & nodal_bcs = nl->getNodalBCWarehouse();
1362 if (!nodal_bcs.hasBoundaryObjects(boundary_id, 0))
1365 const auto & bnd_objects = nodal_bcs.getBoundaryObjects(boundary_id, 0);
1366 for (
const auto & bnd_object : bnd_objects)
1369 if (!bnd_object->requiresGeometricSearch() &&
1370 bnd_object->checkVariableBoundaryIntegrity())
1372 std::set<MooseVariableFieldBase *> vars_to_omit = {
1377 *bnd_object, bnd_object->checkAllVariables(*node, vars_to_omit), bnd_name);
1385 TIME_SECTION(
"BoundaryRestrictedElemIntegrityCheck", 5);
1390 Threads::parallel_reduce(bnd_elems, beict);
1399 mooseError(
"failed to converge initial MultiApp");
1431 TIME_SECTION(
"computeMaterials", 2,
"Computing Initial Material Properties");
1440 for (
unsigned int tid = 0; tid <
n_threads; tid++)
1458 TIME_SECTION(
"lineSearchInitialSetup", 5,
"Initializing Line Search");
1480 "\" has the same name as a scalar variable in the system.");
1491 std::unique_ptr<libMesh::MeshRefinement> displaced_mesh_refinement(
nullptr);
1493 displaced_mesh_refinement = std::make_unique<libMesh::MeshRefinement>(*_displaced_mesh);
1509 displaced_mesh_refinement->uniformly_coarsen();
1557 _aux->timestepSetup();
1559 sys->timestepSetup();
1572 std::vector<UserObject *> userobjs;
1574 for (
auto obj : userobjs)
1575 obj->timestepSetup();
1602 TIME_SECTION(
"checkNonlocalCoupling", 5,
"Checking Nonlocal Coupling");
1605 for (
auto & nl :
_nl)
1607 const auto & all_kernels = nl->getKernelWarehouse();
1608 const auto & kernels = all_kernels.getObjects(tid);
1609 for (
const auto & kernel : kernels)
1611 std::shared_ptr<NonlocalKernel> nonlocal_kernel =
1613 if (nonlocal_kernel)
1621 nl->getIntegratedBCWarehouse();
1622 const auto & integrated_bcs = all_integrated_bcs.
getObjects(tid);
1623 for (
const auto & integrated_bc : integrated_bcs)
1625 std::shared_ptr<NonlocalIntegratedBC> nonlocal_integrated_bc =
1627 if (nonlocal_integrated_bc)
1640 std::set<const MooseVariableFEBase *> uo_jacobian_moose_vars;
1642 std::vector<ShapeElementUserObject *> objs;
1646 .condition<AttribThread>(tid)
1649 for (
const auto & uo : objs)
1652 const auto & mv_deps = uo->jacobianMooseVariables();
1653 uo_jacobian_moose_vars.insert(mv_deps.begin(), mv_deps.end());
1657 std::vector<ShapeSideUserObject *> objs;
1661 .condition<AttribThread>(tid)
1663 for (
const auto & uo : objs)
1666 const auto & mv_deps = uo->jacobianMooseVariables();
1667 uo_jacobian_moose_vars.insert(mv_deps.begin(), mv_deps.end());
1679 for (
unsigned int i = 0; i < moose_vars.size(); ++i)
1681 VariableName var_name = moose_vars[i]->name();
1683 sys->setVariableGlobalDoFs(var_name);
1701 _assembly[tid][i]->prepareJacobianBlock();
1724 for (
auto & nl :
_nl)
1725 nl->prepareFace(tid,
true);
1726 _aux->prepareFace(tid,
false);
1736 const std::vector<dof_id_type> & dof_indices,
1742 _nl[i]->prepare(tid);
1747 _assembly[tid][current_nl_sys_num]->prepareBlock(ivar, jvar, dof_indices);
1752 _assembly[tid][current_nl_sys_num]->prepareBlockNonlocal(
1774 _assembly[tid][i]->setCurrentSubdomainID(did);
1787 _assembly[tid][i]->setCurrentNeighborSubdomainID(did);
1800 _assembly[tid][i]->setCurrentNeighborSubdomainID(did);
2002 std::vector<dof_id_type> & dof_indices,
2003 const std::set<TagID> & tags,
2026 _displaced_problem->addJacobianBlockTags(jacobian, ivar, jvar, dof_map, dof_indices, tags, tid);
2032 jacobian, ivar, jvar, dof_map, dof_indices, jv.
allDofIndices(), tags, tid);
2042 std::vector<dof_id_type> & dof_indices,
2043 std::vector<dof_id_type> & neighbor_dof_indices,
2044 const std::set<TagID> & tags,
2052 neighbor_dof_indices,
2057 jacobian, ivar, jvar, dof_map, dof_indices, neighbor_dof_indices, tags, tid);
2096 TIME_SECTION(
"ghostGhostedBoundaries", 3,
"Ghosting Ghosted Boundaries");
2108 "This function is deprecated and no longer performs any function. Please do not call it."));
2116 unsigned int n_points = points.size();
2133 _zero[tid].resize(max_qpts, 0);
2143 _assembly[tid][i]->reinitAtPhysical(elem, points);
2144 _nl[i]->prepare(tid);
2155 bool have_points = n_points > 0;
2170 sys->reinitElem(elem, tid);
2171 _aux->reinitElem(elem, tid);
2179 const std::vector<Point> & phys_points_in_elem,
2183 "Are you calling this method with a displaced mesh element?");
2187 _assembly[tid][i]->reinitAtPhysical(elem, phys_points_in_elem);
2200 const unsigned int side,
2205 "reinitElemFace with a BoundaryID argument is deprecated because the boundary id was never " 2206 "used. Please call reinitElemFace without the BoundaryID argument instead");
2219 _aux->reinitElemFace(elem, side, tid);
2228 const std::vector<Point> *
const pts,
2229 const std::vector<Real> *
const weights)
2247 _nl[i]->reinitNode(node, tid);
2249 _aux->reinitNode(node, tid);
2261 _nl[i]->reinitNodeFace(node, bnd_id, tid);
2263 _aux->reinitNodeFace(node, bnd_id, tid);
2272 for (
auto & nl :
_nl)
2273 nl->reinitNodes(nodes, tid);
2274 _aux->reinitNodes(nodes, tid);
2283 for (
auto & nl :
_nl)
2284 nl->reinitNodesNeighbor(nodes, tid);
2285 _aux->reinitNodesNeighbor(nodes, tid);
2291 TIME_SECTION(
"reinitScalars", 3,
"Reinitializing Scalar Variables");
2296 for (
auto & nl :
_nl)
2297 nl->reinitScalars(tid, reinit_for_derivative_reordering);
2298 _aux->reinitScalars(tid, reinit_for_derivative_reordering);
2323 _assembly[tid][i]->reinitElemAndNeighbor(elem, side, neighbor, neighbor_side);
2324 _nl[i]->prepareNeighbor(tid);
2328 _aux->prepareNeighbor(tid);
2330 for (
auto & nl :
_nl)
2332 nl->reinitElemFace(elem, side, tid);
2333 nl->reinitNeighborFace(neighbor, neighbor_side, tid);
2335 _aux->reinitElemFace(elem, side, tid);
2336 _aux->reinitNeighborFace(neighbor, neighbor_side, tid);
2345 const auto & displaced_ref_pts =
_assembly[tid][0]->qRuleNeighbor()->get_points();
2365 auto & neighbor =
_assembly[tid][0]->neighbor();
2366 auto & neighbor_side =
_assembly[tid][0]->neighborSide();
2368 if (lower_d_elem_neighbor &&
2371 auto qps =
_assembly[tid][0]->qPointsFaceNeighbor().stdVector();
2372 std::vector<Point> reference_points;
2374 lower_d_elem_neighbor->
dim(), lower_d_elem_neighbor, qps, reference_points);
2387 unsigned int neighbor_side,
2388 const std::vector<Point> & physical_points,
2392 "Are you calling this method with a displaced mesh element?");
2397 _assembly[tid][i]->reinitNeighborAtPhysical(neighbor, neighbor_side, physical_points);
2400 _nl[i]->prepareNeighbor(tid);
2402 _aux->prepareNeighbor(tid);
2408 for (
auto & nl :
_nl)
2409 nl->reinitNeighborFace(neighbor, neighbor_side, tid);
2410 _aux->reinitNeighborFace(neighbor, neighbor_side, tid);
2415 const std::vector<Point> & physical_points,
2419 "Are you calling this method with a displaced mesh element?");
2424 _assembly[tid][i]->reinitNeighborAtPhysical(neighbor, physical_points);
2427 _nl[i]->prepareNeighbor(tid);
2429 _aux->prepareNeighbor(tid);
2435 for (
auto & nl :
_nl)
2436 nl->reinitNeighbor(neighbor, tid);
2437 _aux->reinitNeighbor(neighbor, tid);
2448 std::set<const Elem *> displaced_elements;
2453 for (
const auto & elem : displaced_elements)
2476 for (
auto & nl :
_nl)
2477 nl->subdomainSetup(subdomain, tid);
2491 const std::string & name,
2494 parallel_object_only();
2511 mooseError(
"Unrecognized function functor type");
2517 const std::string & name,
2520 parallel_object_only();
2532 const std::string class_name =
"DefaultNonlinearConvergence";
2536 params.
set<
bool>(
"added_as_default") =
true;
2544 const std::string class_name =
"DefaultMultiAppFixedPointConvergence";
2548 params.
set<
bool>(
"added_as_default") =
true;
2555 const std::string class_name =
"DefaultSteadyStateConvergence";
2559 params.
set<
bool>(
"added_as_default") =
true;
2579 std::istringstream ss(
name);
2583 if (ss >> real_value && ss.eof())
2586 params.
set<
Real>(
"value") = real_value;
2587 addFunction(
"ConstantFunction", ss.str(), params);
2592 std::string
vars =
"x,y,z,t,NaN,pi,e";
2597 params.
set<std::string>(
"expression") =
name;
2625 mooseError(
"The Convergence object '",
name,
"' does not exist.");
2630 const std::vector<std::shared_ptr<Convergence>> &
2638 const std::string & name,
2641 parallel_object_only();
2656 mooseError(
"No MeshDivision object named ",
name,
" of appropriate type");
2669 mooseDeprecated(
"FEProblemBase::getNonlinearSystem() is deprecated, please use " 2670 "FEProblemBase::getNonlinearSystemBase() \n");
2672 mooseAssert(sys_num <
_nl.size(),
"System number greater than the number of nonlinear systems");
2683 const std::string & name,
2693 std::vector<Distribution *> objs;
2697 .condition<AttribName>(
name)
2700 mooseError(
"Unable to find Distribution with name '" +
name +
"'");
2706 const std::string & name,
2710 for (
auto & sampler : samplers)
2717 std::vector<Sampler *> objs;
2721 .condition<AttribThread>(tid)
2726 "Unable to find Sampler with name '" +
name +
2727 "', if you are attempting to access this object in the constructor of another object then " 2728 "the object being retrieved must occur prior to the caller within the input file.");
2736 const std::set<SubdomainID> *
const active_subdomains)
2738 std::set<SubdomainID> subdomainIDs;
2739 if (active_subdomains->size() == 0)
2742 subdomainIDs.insert(subdomains.begin(), subdomains.end());
2745 subdomainIDs.insert(active_subdomains->begin(), active_subdomains->end());
2751 std::string error_prefix =
"";
2754 curr_sys_ptr =
_aux.get();
2755 other_sys_ptr = sys.get();
2756 error_prefix =
"aux";
2760 mooseError(
"Cannot have an auxiliary variable and a solver variable with the same name: ",
2771 const auto stringifyType = [](
FEType t)
2774 mooseError(
"Mismatching types are specified for ",
2776 "variable with name '",
2779 stringifyType(var.
type()),
2781 stringifyType(
type),
2789 std::set<SubdomainID> varSubdomainIDs;
2790 if (varActiveSubdomains.size() == 0)
2793 varSubdomainIDs.insert(subdomains.begin(), subdomains.end());
2796 varSubdomainIDs.insert(varActiveSubdomains.begin(), varActiveSubdomains.end());
2800 const auto isSubset = std::includes(varSubdomainIDs.begin(),
2801 varSubdomainIDs.end(),
2802 subdomainIDs.begin(),
2803 subdomainIDs.end());
2808 const auto stringifySubdomains = [
this](std::set<SubdomainID> subdomainIDs)
2810 std::stringstream s;
2811 for (
auto const i : subdomainIDs)
2819 if (subdomainName.empty())
2822 s << subdomainName <<
" (" << i <<
")";
2827 const std::string msg =
"Mismatching block-restrictions are specified for " +
2828 error_prefix +
"variable with name '" + var_name +
"': {" +
2829 stringifySubdomains(varSubdomainIDs) +
"} and {" +
2830 stringifySubdomains(subdomainIDs) +
"}";
2845 const std::string & var_name,
2848 parallel_object_only();
2850 const auto order = Utility::string_to_enum<Order>(params.
get<
MooseEnum>(
"order"));
2851 const auto family = Utility::string_to_enum<FEFamily>(params.
get<
MooseEnum>(
"family"));
2852 const auto fe_type =
FEType(order, family);
2854 const auto active_subdomains_vector =
2856 const std::set<SubdomainID> active_subdomains(active_subdomains_vector.begin(),
2857 active_subdomains_vector.end());
2864 SolverSystemName sys_name = params.
get<SolverSystemName>(
"solver_sys");
2866 const auto solver_system_number =
solverSysNum(sys_name);
2867 logAdd(
"Variable", var_name, var_type, params);
2868 _solver_systems[solver_system_number]->addVariable(var_type, var_name, params);
2878 std::pair<bool, unsigned int>
2880 const bool error_if_not_found)
const 2887 "If the variable is in our FEProblem solver system map, then it must be in the " 2888 "solver system we expect");
2889 else if (error_if_not_found)
2891 if (
_aux->hasVariable(var_name) ||
_aux->hasScalarVariable(var_name))
2894 " found. Did you specify an auxiliary variable when you meant to specify a " 2895 "solver variable?");
2899 "'. It does not exist in the solver system(s) or auxiliary system");
2907 const std::string & name,
2909 const unsigned int nl_sys_num,
2910 const std::string & base_name,
2911 bool & reinit_displaced)
2917 reinit_displaced =
true;
2940 const std::string & name,
2943 parallel_object_only();
2946 mooseError(
"You are trying to add a Kernel to a linear variable/system, which is not " 2947 "supported at the moment!");
2956 const std::string & name,
2959 parallel_object_only();
2962 mooseError(
"You are trying to add a HDGKernel to a linear variable/system, which is not " 2963 "supported at the moment!");
2972 const std::string & name,
2975 parallel_object_only();
3005 const std::string & name,
3008 parallel_object_only();
3012 mooseError(
"You are trying to add a ScalarKernel to a linear variable/system, which is not " 3013 "supported at the moment!");
3042 const std::string & name,
3045 parallel_object_only();
3050 "You are trying to add a BoundaryCondition to a linear variable/system, which is not " 3051 "supported at the moment!");
3060 const std::string & name,
3063 parallel_object_only();
3067 auto determine_var_param_name = [&
parameters,
this]()
3076 if (!has_secondary_var && !has_primary_var)
3078 "Either a 'secondary_variable' or 'primary_variable' parameter must be supplied for '",
3081 return has_secondary_var ?
"secondary_variable" :
"primary_variable";
3085 const auto nl_sys_num =
3088 mooseError(
"You are trying to add a Constraint to a linear variable/system, which is not " 3089 "supported at the moment!");
3113 const std::string & var_name,
3116 parallel_object_only();
3118 const auto order = Utility::string_to_enum<Order>(params.
get<
MooseEnum>(
"order"));
3119 const auto family = Utility::string_to_enum<FEFamily>(params.
get<
MooseEnum>(
"family"));
3120 const auto fe_type =
FEType(order, family);
3122 const auto active_subdomains_vector =
3124 const std::set<SubdomainID> active_subdomains(active_subdomains_vector.begin(),
3125 active_subdomains_vector.end());
3133 logAdd(
"AuxVariable", var_name, var_type, params);
3134 _aux->addVariable(var_type, var_name, params);
3145 const std::set<SubdomainID> *
const active_subdomains)
3147 parallel_object_only();
3149 mooseDeprecated(
"Please use the addAuxVariable(var_type, var_name, params) API instead");
3154 std::string var_type;
3156 var_type =
"MooseVariableConstMonomial";
3158 var_type =
"MooseVariableScalar";
3160 var_type =
"VectorMooseVariable";
3162 var_type =
"MooseVariable";
3170 if (active_subdomains)
3174 logAdd(
"AuxVariable", var_name, var_type, params);
3175 _aux->addVariable(var_type, var_name, params);
3185 unsigned int components,
3186 const std::set<SubdomainID> *
const active_subdomains)
3188 parallel_object_only();
3190 mooseDeprecated(
"Please use the addAuxVariable(var_type, var_name, params) API instead");
3200 params.
set<
unsigned int>(
"components") = components;
3202 if (active_subdomains)
3206 logAdd(
"Variable", var_name,
"ArrayMooseVariable", params);
3207 _aux->addVariable(
"ArrayMooseVariable", var_name, params);
3218 const std::set<SubdomainID> *
const active_subdomains)
3220 parallel_object_only();
3222 mooseDeprecated(
"Please use the addAuxVariable(var_type, var_name, params) API instead");
3237 params.
set<std::vector<Real>>(
"scaling") = {1};
3238 if (active_subdomains)
3242 logAdd(
"ScalarVariable", var_name,
"MooseVariableScalar", params);
3243 _aux->addVariable(
"MooseVariableScalar", var_name, params);
3250 const std::string & name,
3253 parallel_object_only();
3260 if (!
parameters.
get<std::vector<BoundaryName>>(
"boundary").empty())
3288 const std::string & name,
3291 parallel_object_only();
3320 const std::string & name,
3323 parallel_object_only();
3327 mooseError(
"You are trying to add a DiracKernel to a linear variable/system, which is not " 3328 "supported at the moment!");
3360 const std::string & name,
3363 parallel_object_only();
3367 mooseError(
"You are trying to add a DGKernel to a linear variable/system, which is not " 3368 "supported at the moment!");
3400 const std::string & name,
3414 const std::string & name,
3422 const std::string & name,
3427 addObject<FVInterfaceKernel>(
3433 const std::string & name,
3441 const std::string & name,
3451 const std::string & name,
3454 parallel_object_only();
3458 mooseError(
"You are trying to add a InterfaceKernel to a linear variable/system, which is not " 3459 "supported at the moment!");
3491 const std::string & name,
3492 const VariableName & var_name)
3496 std::string restart_method =
"";
3499 "a checkpoint restart, by IC object '" + ic_name +
"' for variable '" +
name +
"'";
3505 restarted_vars.insert(restarted_vars.end(), nodal_vars.begin(), nodal_vars.end());
3506 restarted_vars.insert(restarted_vars.end(), global_vars.begin(), global_vars.end());
3508 if (std::find(restarted_vars.begin(), restarted_vars.end(), var_name) != restarted_vars.end())
3509 restart_method =
"an Exodus restart, by IC object '" + ic_name +
"' for variable '" +
name +
3510 "' that is also being restarted";
3512 if (!restart_method.empty())
3514 "Initial conditions have been specified during ",
3516 ".\nThis is only allowed if you specify 'allow_initial_conditions_with_restart' to " 3517 "the [Problem], as initial conditions can override restarted fields");
3523 const std::string & name,
3526 parallel_object_only();
3530 const std::string & var_name =
parameters.
get<VariableName>(
"variable");
3545 std::shared_ptr<InitialConditionBase> ic;
3546 if (dynamic_cast<MooseVariable *>(&var))
3548 else if (dynamic_cast<VectorMooseVariable *>(&var))
3550 else if (dynamic_cast<ArrayMooseVariable *>(&var))
3552 else if (dynamic_cast<MooseVariableFVReal *>(&var))
3554 else if (dynamic_cast<MooseLinearVariableFVReal *>(&var))
3557 mooseError(
"Your FE variable in initial condition ",
3559 " must be either of scalar or vector type");
3570 std::shared_ptr<ScalarInitialCondition> ic =
3578 "Variable '", var_name,
"' requested in initial condition '",
name,
"' does not exist.");
3583 const std::string & name,
3586 parallel_object_only();
3590 const std::string & var_name =
parameters.
get<VariableName>(
"variable");
3605 std::shared_ptr<FVInitialConditionBase> ic;
3610 "Your variable for an FVInitialCondition needs to be an a finite volume variable!");
3617 "' requested in finite volume initial condition '",
3619 "' does not exist.");
3625 TIME_SECTION(
"projectSolution", 2,
"Projecting Initial Solutions")
3631 Threads::parallel_reduce(elem_range, cic);
3639 Threads::parallel_reduce(elem_info_range, cfvic);
3643 for (
auto & nl :
_nl)
3644 nl->solution().close();
3645 _aux->solution().close();
3650 Threads::parallel_reduce(bnd_nodes, cbic);
3652 for (
auto & nl :
_nl)
3653 nl->solution().close();
3654 _aux->solution().close();
3662 for (
const auto & ic : ics)
3670 const unsigned int n_SCALAR_dofs = var.
dofIndices().size();
3671 for (
unsigned int i = 0; i < n_SCALAR_dofs; i++)
3682 sys->solution().close();
3683 sys->solution().localize(*sys->system().current_local_solution, sys->dofMap().get_send_list());
3686 _aux->solution().close();
3687 _aux->solution().localize(*
_aux->sys().current_local_solution,
_aux->dofMap().get_send_list());
3695 Threads::parallel_reduce(elem_range, cic);
3698 for (
auto & nl :
_nl)
3699 nl->solution().close();
3700 _aux->solution().close();
3703 Threads::parallel_reduce(bnd_nodes, cbic);
3705 for (
auto & nl :
_nl)
3706 nl->solution().close();
3707 _aux->solution().close();
3715 for (
const auto & ic : ics)
3723 const unsigned int n_SCALAR_dofs = var.
dofIndices().size();
3724 for (
unsigned int i = 0; i < n_SCALAR_dofs; i++)
3733 for (
auto & nl :
_nl)
3735 nl->solution().close();
3736 nl->solution().localize(*nl->system().current_local_solution, nl->dofMap().get_send_list());
3739 _aux->solution().close();
3740 _aux->solution().localize(*
_aux->sys().current_local_solution,
_aux->dofMap().get_send_list());
3743 std::shared_ptr<MaterialBase>
3752 name +=
"_neighbor";
3765 "), but its compute flag is set to true. This indicates that MOOSE is " 3766 "computing this property which may not be desired and produce un-expected " 3787 mooseError(
"FEProblemBase::getMaterialData(): Invalid MaterialDataType ",
type);
3795 "ignore_zeros_in_jacobian",
3796 "We likely cannot preserve the sparsity pattern if ignoring zeros in the Jacobian, which " 3797 "leads to removing those entries from the Jacobian sparsity pattern");
3810 const std::string & name,
3813 parallel_object_only();
3815 auto add_functor_materials = [&](
const auto &
parameters,
const auto &
name)
3820 std::shared_ptr<MaterialBase> material =
3834 add_functor_materials(disp_params,
name +
"_displaced");
3840 const std::string & name,
3848 const std::string & name,
3856 const std::string & mat_name,
3857 const std::string & name,
3860 parallel_object_only();
3885 std::shared_ptr<MaterialBase> material =
3888 bool discrete = !material->getParam<
bool>(
"compute");
3892 if (material->boundaryRestricted() ||
dynamic_cast<FunctorMaterial *
>(material.get()))
3898 for (
auto && warehouse : warehouses)
3899 warehouse->addObject(material, tid);
3911 std::string object_name;
3920 object_name =
name +
"_face";
3921 std::shared_ptr<MaterialBase> face_material =
3927 current_parameters.set<
bool>(
"_neighbor") =
true;
3928 object_name =
name +
"_neighbor";
3929 std::shared_ptr<MaterialBase> neighbor_material =
3938 for (
auto && warehouse : warehouses)
3939 warehouse->addObjects(material, neighbor_material, face_material, tid);
3942 const std::string & base =
parameters.
get<std::string>(
"_moose_base");
3944 const auto param_names =
3949 for (
const auto & p_name : param_names)
3952 p_name.parameter());
3954 p_name.parameter());
3956 p_name.parameter());
3958 primary_name, face_name,
false);
3960 primary_name, neighbor_name,
false);
3971 std::set<MooseVariableFEBase *> needed_moose_vars;
3972 std::unordered_set<unsigned int> needed_mat_props;
3981 for (
const auto id : ids)
3988 needed_moose_vars.insert(current_active_elemental_moose_variables.begin(),
3989 current_active_elemental_moose_variables.end());
3991 needed_mat_props.insert(consumer_needed_mat_props.begin(), consumer_needed_mat_props.end());
4002 auto && elem =
_assembly[tid][0]->elem();
4003 unsigned int n_points =
_assembly[tid][0]->qRule()->n_points();
4006 material_data.
resize(n_points);
4010 material_data.swap(*elem);
4023 const bool swap_stateful,
4024 const std::deque<MaterialBase *> *
const reinit_mats)
4028 auto && elem =
_assembly[tid][0]->elem();
4029 unsigned int side =
_assembly[tid][0]->side();
4030 unsigned int n_points =
_assembly[tid][0]->qRuleFace()->n_points();
4033 bnd_material_data.
resize(n_points);
4035 if (swap_stateful && !bnd_material_data.isSwapped())
4036 bnd_material_data.swap(*elem, side);
4039 bnd_material_data.reset(
4043 bnd_material_data.reinit(*reinit_mats);
4045 bnd_material_data.reinit(
4053 const bool swap_stateful,
4054 const std::deque<MaterialBase *> *
const reinit_mats)
4064 mooseAssert(neighbor,
"neighbor should be non-null");
4066 "The provided blk_id " << blk_id <<
" and neighbor subdomain ID " 4069 unsigned int n_points =
_assembly[tid][0]->qRuleNeighbor()->n_points();
4072 neighbor_material_data.
resize(n_points);
4076 neighbor_material_data.swap(*neighbor, neighbor_side);
4079 neighbor_material_data.reset(
4083 neighbor_material_data.reinit(*reinit_mats);
4085 neighbor_material_data.reinit(
4093 const bool swap_stateful,
4094 const std::deque<MaterialBase *> *
const reinit_mats)
4098 auto && elem =
_assembly[tid][0]->elem();
4099 unsigned int side =
_assembly[tid][0]->side();
4100 unsigned int n_points =
_assembly[tid][0]->qRuleFace()->n_points();
4103 bnd_material_data.
resize(n_points);
4105 if (swap_stateful && !bnd_material_data.isSwapped())
4106 bnd_material_data.swap(*elem, side);
4112 bnd_material_data.reinit(*reinit_mats);
4126 unsigned int side =
_assembly[tid][0]->side();
4127 unsigned int n_points =
_assembly[tid][0]->qRuleFace()->n_points();
4130 bnd_material_data.
resize(n_points);
4132 if (swap_stateful && !bnd_material_data.isSwapped())
4133 bnd_material_data.swap(*elem, side);
4143 auto && elem =
_assembly[tid][0]->elem();
4150 auto && elem =
_assembly[tid][0]->elem();
4151 unsigned int side =
_assembly[tid][0]->side();
4160 unsigned int neighbor_side =
4174 neighbor_side =
_assembly[tid][0]->side();
4175 mooseAssert(neighbor,
"We should have an appropriate value for elem coming from Assembly");
4186 const std::string & name,
4187 const std::string & type,
4191 _console <<
"[DBG] Adding " << system <<
" '" <<
name <<
"' of type " <<
type << std::endl;
4198 const std::string & object_name,
4199 const std::string & var_param_name)
4205 unsigned int sys_num = 0;
4217 if (sys_num ==
_aux->number())
4233 if (sys_num ==
_aux->number())
4242 const std::string & name,
4249 " already exists. You may not add a Postprocessor by the same name.");
4256 const std::string & name,
4263 " already exists. You may not add a VectorPostprocessor by the same name.");
4270 const std::string & name,
4277 " already exists. You may not add a Reporter by the same name.");
4282 std::vector<std::shared_ptr<UserObject>>
4284 const std::string & name,
4287 parallel_object_only();
4289 std::vector<std::shared_ptr<UserObject>> uos;
4297 std::shared_ptr<UserObject> user_object =
4300 uos.push_back(user_object);
4303 user_object->setPrimaryThreadCopy(uos[0].
get());
4324 if (euo || nuo || duo)
4326 else if (suo || duo)
4329 else if (iuob || duo)
4334 if ((guo && !tguo) || muo)
4343 const decltype(uos)::size_type uo_index = uos.front()->needThreadedCopy() ? tid : 0;
4358 std::vector<UserObject *> objs;
4362 .condition<AttribThread>(tid)
4366 mooseError(
"Unable to find user object with name '" +
name +
"'");
4367 mooseAssert(objs.size() == 1,
"Should only find one UO");
4374 std::vector<Positions *> objs;
4378 .condition<AttribName>(
name)
4381 mooseError(
"Unable to find Positions object with name '" +
name +
"'");
4382 mooseAssert(objs.size() == 1,
"Should only find one Positions");
4389 std::vector<UserObject *> objs;
4393 .condition<AttribThread>(0)
4396 return !objs.empty();
4407 std::size_t t_index)
const 4416 std::size_t t_index)
4425 mooseDeprecated(
"FEProblemBase::hasPostprocssor is being removed; use " 4426 "hasPostprocessorValueByName instead.");
4432 const std::string & vector_name,
4433 std::size_t t_index)
const 4441 const std::string & vector_name,
4443 std::size_t t_index)
4453 return getUserObject<VectorPostprocessor>(object_name, tid);
4461 const auto & objects = it.second.getActiveObjects();
4462 for (
const auto & obj : objects)
4463 obj->parentOutputPositionChanged();
4480 TIME_SECTION(
"computeIndicators", 1,
"Computing Indicators");
4484 const auto old_do_derivatives = ADReal::do_derivatives;
4485 ADReal::do_derivatives =
false;
4487 std::vector<std::string>
fields;
4491 for (
const auto & indicator : indicators)
4492 fields.push_back(indicator->name());
4496 for (
const auto & internal_indicator : internal_indicators)
4497 fields.push_back(internal_indicator->name());
4504 _aux->solution().close();
4509 _aux->solution().close();
4512 ADReal::do_derivatives = old_do_derivatives;
4521 TIME_SECTION(
"computeMarkers", 1,
"Computing Markers");
4523 std::vector<std::string>
fields;
4527 for (
const auto & marker : markers)
4528 fields.push_back(marker->name());
4537 for (
const auto & marker : markers)
4538 marker->markerSetup();
4544 _aux->solution().close();
4581 _aux->customSetup(exec_type);
4582 for (
auto & nl :
_nl)
4583 nl->customSetup(exec_type);
4595 std::vector<UserObject *> userobjs;
4597 for (
auto obj : userobjs)
4598 obj->customSetup(exec_type);
4650 std::unique_ptr<NumericVector<Number>> x =
_aux->currentSolution()->clone();
4658 const Real check_tol = 1e-8;
4660 const Real xnorm = x->l2_norm();
4661 *x -= *
_aux->currentSolution();
4662 if (x->l2_norm() > check_tol * xnorm)
4664 const auto & sys =
_aux->system();
4665 const unsigned int n_vars = sys.n_vars();
4666 std::multimap<Real, std::string, std::greater<Real>> ordered_map;
4670 ordered_map.emplace(vnorm, sys.variable_name(i));
4673 std::ostringstream oss;
4674 for (
const auto & [error_norm, var_name] : ordered_map)
4675 oss <<
" {" << var_name <<
", " << error_norm <<
"},\n";
4677 mooseError(
"Aux kernels, user objects appear to have states for aux variables on ",
4679 ".\nVariable error norms in descending order:\n",
4684 if (pp_values.
size() != new_pp_values.
size())
4685 mooseError(
"Second execution for uo/aux state check should not change the number of " 4686 "real reporter values");
4689 pp_values -= new_pp_values;
4690 if (pp_values.
l2_norm() > check_tol * ppnorm)
4693 std::multimap<Real, std::string, std::greater<Real>> ordered_map;
4695 ordered_map.emplace(
std::abs(pp_values(i)), pp_names[i]);
4697 std::ostringstream oss;
4698 for (
const auto & [error_norm, pp_name] : ordered_map)
4699 oss <<
" {" << pp_name <<
", " << error_norm <<
"},\n";
4701 mooseError(
"Aux kernels, user objects appear to have states for real reporter values on ",
4703 ".\nErrors of real reporter values in descending order:\n",
4713 std::vector<UserObject *> objs;
4714 query.queryInto(objs);
4719 for (
auto obj : objs)
4720 if (obj->primaryThreadCopy())
4721 obj->primaryThreadCopy()->threadJoin(*obj);
4727 for (
auto obj : objs)
4729 if (isgen && dynamic_cast<ThreadedGeneralUserObject *>(obj))
4735 _console <<
"[DBG] Initializing, executing & finalizing general UO '" << obj->name()
4760 auto reporter =
dynamic_cast<Reporter *
>(obj);
4769 const std::string & name)
4776 .condition<AttribExecOns>(
type)
4797 TIME_SECTION(
"computeUserObjects", 1,
"Computing User Objects");
4808 std::vector<UserObject *> uos;
4810 std::set<int> execution_groups;
4811 for (
const auto & uo : uos)
4812 execution_groups.insert(uo->getParam<
int>(
"execution_order_group"));
4815 for (
const auto execution_group : execution_groups)
4819 std::vector<GeneralUserObject *> genobjs;
4822 std::vector<UserObject *> userobjs;
4828 .queryInto(userobjs);
4830 std::vector<UserObject *> tgobjs;
4835 std::vector<UserObject *> nodal;
4838 std::vector<MortarUserObject *> mortar;
4841 if (userobjs.empty() && genobjs.empty() && tgobjs.empty() && nodal.empty() && mortar.empty())
4850 for (
auto obj : userobjs)
4851 obj->residualSetup();
4852 for (
auto obj : nodal)
4853 obj->residualSetup();
4854 for (
auto obj : mortar)
4855 obj->residualSetup();
4856 for (
auto obj : tgobjs)
4857 obj->residualSetup();
4858 for (
auto obj : genobjs)
4859 obj->residualSetup();
4863 for (
auto obj : userobjs)
4864 obj->jacobianSetup();
4865 for (
auto obj : nodal)
4866 obj->jacobianSetup();
4867 for (
auto obj : mortar)
4868 obj->jacobianSetup();
4869 for (
auto obj : tgobjs)
4870 obj->jacobianSetup();
4871 for (
auto obj : genobjs)
4872 obj->jacobianSetup();
4875 for (
auto obj : userobjs)
4879 if (!userobjs.empty())
4898 for (
const auto & uo : userobjs)
4899 if (
auto euo = dynamic_cast<const ElementUserObject *>(uo);
4900 euo && euo->hasWritableCoupledVariables())
4902 _aux->solution().close();
4903 _aux->system().update();
4911 for (
auto obj : nodal)
4921 for (
const auto & uo : nodal)
4922 if (
auto nuo = dynamic_cast<const NodalUserObject *>(uo);
4923 nuo && nuo->hasWritableCoupledVariables())
4925 _aux->solution().close();
4926 _aux->system().update();
4932 for (
auto obj : mortar)
4934 if (!mortar.empty())
4936 auto create_and_run_mortar_functors = [
this,
type, &mortar](
const bool displaced)
4940 for (
const auto & mortar_interface : mortar_interfaces)
4942 const auto primary_secondary_boundary_pair = mortar_interface.first;
4943 auto mortar_uos_to_execute =
4945 primary_secondary_boundary_pair.second,
4948 const auto & mortar_generation_object = mortar_interface.second;
4950 auto *
const subproblem = displaced
4952 : static_cast<SubProblem *>(
this);
4954 mortar_generation_object,
4958 subproblem->assembly(0, 0));
4964 create_and_run_mortar_functors(
false);
4966 create_and_run_mortar_functors(
true);
4968 for (
auto obj : mortar)
4973 for (
auto obj : tgobjs)
4975 std::vector<GeneralUserObject *> tguos_zero;
4979 .queryInto(tguos_zero);
4980 for (
auto obj : tguos_zero)
4982 std::vector<GeneralUserObject *> tguos;
4983 auto q =
query.clone()
5009 TIME_SECTION(
"executeControls", 1,
"Executing Controls");
5015 for (
const auto & it : controls_wh.getActiveObjects())
5020 std::vector<std::string> & dependent_controls = it->getDependencies();
5021 for (
const auto & depend_name : dependent_controls)
5023 if (controls_wh.hasActiveObject(depend_name))
5025 auto dep_control = controls_wh.getActiveObject(depend_name);
5026 resolver.
addEdge(dep_control, it);
5031 "\" was not created, did you make a " 5032 "spelling mistake or forget to include it " 5033 "in your input file?");
5039 if (!ordered_controls.empty())
5043 for (
const auto & control : ordered_controls)
5056 std::vector<Sampler *> objects;
5060 .condition<AttribThread>(tid)
5062 .queryInto(objects);
5064 if (!objects.empty())
5066 TIME_SECTION(
"executeSamplers", 1,
"Executing Samplers");
5067 FEProblemBase::objectSetupHelper<Sampler>(objects, exec_type);
5068 FEProblemBase::objectExecuteHelper<Sampler>(objects);
5076 TIME_SECTION(
"updateActiveObjects", 5,
"Updating Active Objects");
5080 for (
auto & nl :
_nl)
5081 nl->updateActive(tid);
5082 _aux->updateActive(tid);
5109 TIME_SECTION(
"reinitBecauseOfGhostingOrNewGeomObjects",
5111 "Reinitializing Because of Geometric Search Objects");
5135 const std::string & name,
5138 parallel_object_only();
5140 const auto nl_sys_num =
5146 mooseError(
"You are trying to add a DGKernel to a linear variable/system, which is not " 5147 "supported at the moment!");
5160 for (
auto & nl :
_nl)
5166 const std::string & name,
5169 parallel_object_only();
5195 std::shared_ptr<Indicator> indicator =
5198 std::shared_ptr<InternalSideIndicatorBase> isi =
5209 const std::string & name,
5212 parallel_object_only();
5246 const std::string & name,
5249 parallel_object_only();
5278 multi_app->setupPositions();
5283 std::shared_ptr<TransientMultiApp> trans_multi_app =
5285 if (trans_multi_app)
5301 std::shared_ptr<MultiApp>
5312 std::string string_direction;
5314 string_direction =
" To ";
5315 else if (from_multiapp)
5316 string_direction =
" From ";
5318 string_direction =
" Between ";
5326 TIME_SECTION(
"execMultiAppTransfers", 1,
"Executing Transfers");
5333 <<
"MultiApps" << COLOR_DEFAULT <<
":" << std::endl;
5336 {
"Name",
"Type",
"From",
"To"});
5339 for (
const auto & transfer : transfers)
5343 table.addRow(multiapp_transfer->name(),
5344 multiapp_transfer->type(),
5345 multiapp_transfer->getFromName(),
5346 multiapp_transfer->getToName());
5353 for (
const auto & transfer : transfers)
5356 transfer->execute();
5363 << COLOR_DEFAULT << std::endl;
5370 << COLOR_DEFAULT << std::endl;
5374 std::vector<std::shared_ptr<Transfer>>
5385 std::vector<std::shared_ptr<Transfer>>
5411 const std::vector<MooseSharedPointer<MultiApp>> & multi_apps =
5415 for (
const auto & multi_app : multi_apps)
5416 multi_app->preTransfer(
_dt,
_time);
5425 if (multi_apps.size())
5427 TIME_SECTION(
"execMultiApps", 1,
"Executing MultiApps",
false);
5431 << COLOR_DEFAULT << std::endl;
5433 bool success =
true;
5435 for (
const auto & multi_app : multi_apps)
5437 success = multi_app->solveStep(
_dt,
_time, auto_advance);
5452 << COLOR_DEFAULT << std::endl;
5467 for (
const auto & multi_app : multi_apps)
5468 multi_app->finalize();
5476 for (
const auto & multi_app : multi_apps)
5477 multi_app->postExecute();
5485 if (multi_apps.size())
5486 for (
const auto & multi_app : multi_apps)
5487 multi_app->incrementTStep(
_time);
5495 if (multi_apps.size())
5498 _console << COLOR_CYAN <<
"\nAdvancing MultiApps on " <<
type.name() << COLOR_DEFAULT
5501 for (
const auto & multi_app : multi_apps)
5502 multi_app->finishStep(recurse_through_multiapp_levels);
5507 _console << COLOR_CYAN <<
"Finished Advancing MultiApps on " <<
type.name() <<
"\n" 5508 << COLOR_DEFAULT << std::endl;
5517 if (multi_apps.size())
5519 TIME_SECTION(
"backupMultiApps", 5,
"Backing Up MultiApp");
5522 _console << COLOR_CYAN <<
"\nBacking Up MultiApps on " <<
type.name() << COLOR_DEFAULT
5525 for (
const auto & multi_app : multi_apps)
5526 multi_app->backup();
5531 _console << COLOR_CYAN <<
"Finished Backing Up MultiApps on " <<
type.name() <<
"\n" 5532 << COLOR_DEFAULT << std::endl;
5541 if (multi_apps.size())
5546 _console << COLOR_CYAN <<
"\nRestoring Multiapps on " <<
type.name()
5547 <<
" because of solve failure!" << COLOR_DEFAULT << std::endl;
5549 _console << COLOR_CYAN <<
"\nRestoring MultiApps on " <<
type.name() << COLOR_DEFAULT
5553 for (
const auto & multi_app : multi_apps)
5554 multi_app->restore(force);
5559 _console << COLOR_CYAN <<
"Finished Restoring MultiApps on " <<
type.name() <<
"\n" 5560 << COLOR_DEFAULT << std::endl;
5571 for (
const auto & multi_app : multi_apps)
5572 smallest_dt =
std::min(smallest_dt, multi_app->computeDT());
5582 TIME_SECTION(
"execTransfers", 3,
"Executing Transfers");
5586 for (
const auto & transfer : transfers)
5587 transfer->execute();
5593 const std::string & name,
5596 parallel_object_only();
5627 std::shared_ptr<MultiApp> multiapp;
5640 exec_enum = multiapp->getParam<
ExecFlagEnum>(
"execute_on");
5648 std::shared_ptr<MultiAppTransfer> multi_app_transfer =
5650 if (multi_app_transfer)
5667 if (sys->hasVariable(var_name))
5669 if (
_aux->hasVariable(var_name))
5679 if (sys->hasVariable(var_name))
5687 const std::string & var_name,
5699 if (sys->hasVariable(var_name))
5700 return sys->getFieldVariable<
Real>(tid, var_name);
5701 if (
_aux->hasVariable(var_name))
5702 return _aux->getFieldVariable<
Real>(tid, var_name);
5711 if (sys->hasVariable(var_name))
5712 return sys->getActualFieldVariable<
Real>(tid, var_name);
5713 if (
_aux->hasVariable(var_name))
5714 return _aux->getActualFieldVariable<
Real>(tid, var_name);
5723 if (sys->hasVariable(var_name))
5725 if (
_aux->hasVariable(var_name))
5735 if (sys->hasVariable(var_name))
5737 if (
_aux->hasVariable(var_name))
5747 if (sys->hasScalarVariable(var_name))
5749 if (
_aux->hasScalarVariable(var_name))
5759 if (sys->hasScalarVariable(var_name))
5760 return sys->getScalarVariable(tid, var_name);
5761 if (
_aux->hasScalarVariable(var_name))
5762 return _aux->getScalarVariable(tid, var_name);
5773 else if (
_aux->hasVariable(var_name) ||
_aux->hasScalarVariable(var_name))
5774 return _aux->system();
5776 mooseError(
"Unable to find a system containing the variable " + var_name);
5878 mat->setActiveProperties(mat_prop_ids);
5880 mat->setActiveProperties(mat_prop_ids);
5882 mat->setActiveProperties(mat_prop_ids);
5902 #ifdef LIBMESH_ENABLE_AMR 5912 const std::string & redistributer_name,
5913 const bool use_displaced_mesh)
5917 redistribute_params.
set<std::string>(
"for_whom") = this->
name();
5921 redistribute_params.
set<
bool>(
"use_displaced_mesh") = use_displaced_mesh;
5924 std::shared_ptr<RedistributeProperties> redistributer =
5926 "RedistributeProperties", redistributer_name, redistribute_params);
5940 add_redistributer(
_mesh,
"mesh_property_redistributer",
false);
5942 add_redistributer(
_displaced_problem->mesh(),
"displaced_mesh_property_redistributer",
true);
5944 #endif // LIBMESH_ENABLE_AMR 5964 mooseError(
"Max quadrature points per element assumptions made in some code (e.g. Coupleable ",
5965 "and MaterialPropertyInterface classes) have been violated.\n",
5966 "Complain to Moose developers to have constMaxQpsPerElem increased from ",
5974 _zero[tid].resize(max_qpts, 0);
6017 const bool allow_negative_qweights)
6026 if (order < _aux->getMinQuadratureOrder())
6027 order =
_aux->getMinQuadratureOrder();
6031 volume_order = order;
6039 type, order, volume_order, face_order, block, allow_negative_qweights);
6043 type, order, volume_order, face_order, block, allow_negative_qweights);
6054 mooseError(
"Someone told us (the FEProblemBase) to trust the user coupling matrix, but we " 6055 "haven't been provided a coupling matrix!");
6076 _cm[i] = std::move(cm);
6083 mooseError(
"Someone told us (the FEProblemBase) to trust the user coupling matrix, but we " 6084 "haven't been provided a coupling matrix!");
6092 TIME_SECTION(
"setNonlocalCouplingMatrix", 5,
"Setting Nonlocal Coupling Matrix");
6095 mooseError(
"Nonlocal kernels are weirdly stored on the FEProblem so we don't currently support " 6096 "multiple nonlinear systems with nonlocal kernels.");
6100 auto & nl =
_nl[nl_sys_num];
6102 unsigned int n_vars = nl->nVariables();
6103 nonlocal_cm.resize(
n_vars);
6104 const auto &
vars = nl->getVariables(0);
6107 for (
const auto & ivar :
vars)
6109 for (
const auto & kernel : nonlocal_kernel)
6111 for (
unsigned int i = ivar->number(); i < ivar->number() + ivar->count(); ++i)
6112 if (i == kernel->variable().number())
6113 for (
const auto & jvar :
vars)
6118 unsigned int j = jvar->number();
6119 nonlocal_cm(i, j) = 1;
6123 for (
const auto & integrated_bc : nonlocal_integrated_bc)
6125 for (
unsigned int i = ivar->number(); i < ivar->number() + ivar->count(); ++i)
6126 if (i == integrated_bc->variable().number())
6127 for (
const auto & jvar :
vars)
6132 unsigned int j = jvar->number();
6133 nonlocal_cm(i, j) = 1;
6143 const unsigned int jvar,
6144 const unsigned int nl_sys)
const 6146 return (*
_cm[nl_sys])(ivar, jvar);
6149 std::vector<std::pair<MooseVariableFEBase *, MooseVariableFEBase *>> &
6152 return _assembly[tid][nl_sys]->couplingEntries();
6155 std::vector<std::pair<MooseVariableFEBase *, MooseVariableFEBase *>> &
6158 return _assembly[tid][nl_sys]->nonlocalCouplingEntries();
6167 TIME_SECTION(
"init", 2,
"Initializing");
6183 unsigned int n_vars = nl->nVariables();
6185 TIME_SECTION(
"fillCouplingMatrix", 3,
"Filling Coupling Matrix");
6190 cm = std::make_unique<CouplingMatrix>(
n_vars);
6191 for (
unsigned int i = 0; i <
n_vars; i++)
6197 cm = std::make_unique<CouplingMatrix>(
n_vars);
6198 for (
unsigned int i = 0; i <
n_vars; i++)
6199 for (
unsigned int j = 0; j <
n_vars; j++)
6209 nl->dofMap()._dof_coupling = cm.get();
6215 nl->dofMap()._dof_coupling =
nullptr;
6217 nl->dofMap().attach_extra_sparsity_function(&
extraSparsity, nl.get());
6218 nl->dofMap().attach_extra_send_list_function(&
extraSendList, nl.get());
6222 mooseError(
"No variables specified in nonlinear system '", nl->name(),
"'.");
6244 for (
auto & nl :
_nl)
6246 nl->turnOffJacobian();
6264 TIME_SECTION(
"EquationSystems::Init", 2,
"Initializing Equation Systems");
6286 "Coupling matrix not set for system " 6288 <<
". This should only happen if a preconditioner was not setup for this system");
6301 std::istringstream ss(nl_sys_name);
6302 unsigned int nl_sys_num;
6303 if (!(ss >> nl_sys_num) || !ss.eof())
6312 std::istringstream ss(linear_sys_name);
6313 unsigned int linear_sys_num;
6314 if (!(ss >> linear_sys_num) || !ss.eof())
6317 return linear_sys_num;
6323 std::istringstream ss(solver_sys_name);
6324 unsigned int solver_sys_num;
6325 if (!(ss >> solver_sys_num) || !ss.eof())
6329 mooseError(
"The solver system number was requested for system '" + solver_sys_name,
6330 "' but this system does not exist in the Problem. Systems can be added to the " 6331 "problem using the 'nl_sys_names' parameter.\nSystems in the Problem: " +
6333 solver_sys_num = search->second;
6336 return solver_sys_num;
6343 if (solver_sys->hasVariable(variable_name))
6344 return solver_sys->number();
6345 mooseAssert(
_aux,
"Should have an auxiliary system");
6346 if (
_aux->hasVariable(variable_name))
6347 return _aux->number();
6351 "' was not found in any solver (nonlinear/linear) or auxiliary system");
6357 TIME_SECTION(
"solve", 1,
"Solving",
false);
6371 #if PETSC_RELEASE_LESS_THAN(3, 12, 0) 6410 #if !PETSC_RELEASE_LESS_THAN(3, 12, 0) 6412 LibmeshPetscCall(PetscOptionsPop());
6429 TIME_SECTION(
"checkExceptionAndStopSolve", 5);
6450 <<
"To recover, the solution will fail and then be re-attempted with a reduced time " 6465 _aux->solution().close();
6479 mooseError(
"The following parallel-communicated exception was detected during " +
6482 "\nBecause this did not occur during residual evaluation, there" 6483 " is no way to handle this, so the solution is aborting.\n");
6491 ADReal::do_derivatives =
true;
6516 TIME_SECTION(
"solve", 1,
"Solving",
false);
6526 #if PETSC_RELEASE_LESS_THAN(3, 12, 0) 6528 options, solver_params));
6546 #if !PETSC_RELEASE_LESS_THAN(3, 12, 0) 6548 LibmeshPetscCall(PetscOptionsPop());
6564 return _nl[nl_sys_num]->nNonlinearIterations();
6570 return _nl[nl_sys_num]->nLinearIterations();
6576 return _nl[nl_sys_num]->finalNonlinearResidual();
6582 return _nl[nl_sys_num]->computingPreSMOResidual();
6588 TIME_SECTION(
"copySolutionsBackwards", 3,
"Copying Solutions Backward");
6591 sys->copySolutionsBackwards();
6592 _aux->copySolutionsBackwards();
6598 TIME_SECTION(
"advanceState", 5,
"Advancing State");
6601 sys->copyOldSolutions();
6602 _aux->copyOldSolutions();
6628 TIME_SECTION(
"restoreSolutions", 5,
"Restoring Solutions");
6632 "There is currently no way to restore not-zeroed vectors.");
6637 _console <<
"Restoring solutions on system " << sys->name() <<
"..." << std::endl;
6638 sys->restoreSolutions();
6642 _console <<
"Restoring solutions on Auxiliary system..." << std::endl;
6643 _aux->restoreSolutions();
6646 _console <<
"Restoring postprocessor, vector-postprocessor, and reporter data..." << std::endl;
6656 TIME_SECTION(
"saveOldSolutions", 5,
"Saving Old Solutions");
6659 sys->saveOldSolutions();
6660 _aux->saveOldSolutions();
6666 TIME_SECTION(
"restoreOldSolutions", 5,
"Restoring Old Solutions");
6669 sys->restoreOldSolutions();
6670 _aux->restoreOldSolutions();
6676 TIME_SECTION(
"outputStep", 1,
"Outputting");
6713 TIME_SECTION(
"onTimestepBegin", 2);
6715 for (
auto & nl :
_nl)
6716 nl->onTimestepBegin();
6732 switch (state.
state)
6741 mooseError(
"Unhandled state ", state.
state,
" in FEProblemBase::getTimeFromStateArg");
6747 const std::string & name,
6750 parallel_object_only();
6762 _aux->addDotVectors();
6763 for (
auto & nl :
_nl)
6765 nl->addDotVectors();
6767 auto tag_udot = nl->getTimeIntegrators()[0]->uDotFactorTag();
6768 if (!nl->hasVector(tag_udot))
6769 nl->associateVectorToTag(*nl->solutionUDot(), tag_udot);
6770 auto tag_udotdot = nl->getTimeIntegrators()[0]->uDotDotFactorTag();
6772 nl->associateVectorToTag(*nl->solutionUDotDot(), tag_udotdot);
6782 const std::string & name,
6785 parallel_object_only();
6788 mooseError(
"Vector bounds cannot be used with LinearSystems!");
6794 for (
auto & nl :
_nl)
6795 nl->setPredictor(predictor);
6819 residual->scale(-1.0);
6821 return residual->l2_norm();
6827 TIME_SECTION(
"computeResidualL2Norm", 2,
"Computing L2 Norm of Residual");
6831 for (
auto sys :
_nl)
6851 parallel_object_only();
6853 TIME_SECTION(
"computeResidualSys", 5);
6871 const unsigned int nl_sys_num)
6880 mooseAssert(
_fe_vector_tags.empty(),
"This should be empty indicating a clean starting state");
6903 "This should be empty indicating a clean starting state");
6915 for (
auto & tag : tags)
6933 for (
auto index :
make_range(matrix.row_start(), matrix.row_stop()))
6934 matrix.add(index, index, 0);
6937 _aux->zeroVariablesForResidual();
6961 for (
unsigned int tid = 0; tid <
n_threads; tid++)
6966 _aux->residualSetup();
7043 mooseError(
"An unhandled MooseException was raised during residual computation. Please " 7044 "contact the MOOSE team for assistance.");
7051 const std::set<TagID> & tags)
7053 parallel_object_only();
7055 TIME_SECTION(
"computeResidualInternal", 1);
7076 mooseError(
"An unhandled MooseException was raised during residual computation. Please " 7077 "contact the MOOSE team for assistance.");
7086 TIME_SECTION(
"computeResidualType", 5);
7107 mooseError(
"An unhandled MooseException was raised during residual computation. Please " 7108 "contact the MOOSE team for assistance.");
7115 auto create_exception_message =
7116 [&calling_method](
const std::string & exception_type,
const auto & exception)
7118 return std::string(
"A " + exception_type +
" was raised during FEProblemBase::" +
7119 calling_method +
"\n" + std::string(exception.what()));
7128 setException(create_exception_message(
"libMesh::LogicError", e));
7132 setException(create_exception_message(
"MooseException", e));
7134 catch (
const MetaPhysicL::LogicError & e)
7150 mooseError(create_exception_message(
"libMesh::PetscSolverException", e));
7152 catch (
const std::exception & e)
7154 const auto message = create_exception_message(
"std::exception", e);
7167 parallel_object_only();
7173 TIME_SECTION(
"computeResidualTags", 5,
"Computing Residual");
7175 ADReal::do_derivatives =
false;
7179 _aux->zeroVariablesForResidual();
7193 for (
unsigned int tid = 0; tid <
n_threads; tid++)
7198 _aux->residualSetup();
7269 const unsigned int nl_sys_num)
7276 for (
auto & tag : tags)
7285 const std::set<TagID> & tags)
7287 TIME_SECTION(
"computeJacobianInternal", 1);
7307 TIME_SECTION(
"computeJacobianTags", 5,
"Computing Jacobian");
7309 for (
auto tag : tags)
7321 for (
auto index :
make_range(matrix.row_start(), matrix.row_stop()))
7322 matrix.add(index, index, 0);
7325 _aux->zeroVariablesForJacobian();
7341 for (
unsigned int tid = 0; tid <
n_threads; tid++)
7346 _aux->jacobianSetup();
7354 for (
unsigned int tid = 0; tid <
n_threads; tid++)
7401 const unsigned int nl_sys_num)
7403 TIME_SECTION(
"computeTransientImplicitJacobian", 2);
7425 JacobianBlock jac_block(precond_system, jacobian, ivar, jvar);
7426 std::vector<JacobianBlock *>
blocks = {&jac_block};
7441 "I expect these system numbers to be the same");
7446 TIME_SECTION(
"computeBounds", 1,
"Computing Bounds");
7455 _aux->residualSetup();
7479 const bool compute_gradients)
7481 TIME_SECTION(
"computeLinearSystemSys", 5);
7514 const std::set<TagID> & vector_tags,
7515 const std::set<TagID> & matrix_tags,
7516 const bool compute_gradients)
7518 TIME_SECTION(
"computeLinearSystemTags", 5,
"Computing Linear System");
7522 for (
auto tag : matrix_tags)
7541 _aux->jacobianSetup();
7554 _console <<
"\nA MooseException was raised during Auxiliary variable computation.\n" 7555 <<
"The next solve will fail, the timestep will be reduced, and we will try again.\n" 7585 "I expect these system numbers to be the same");
7588 for (
unsigned int i = 0; i <
subspaceDim(
"NearNullSpace"); ++i)
7590 std::stringstream postfix;
7591 postfix <<
"_" << i;
7592 std::string modename =
"NearNullSpace" + postfix.str();
7602 "I expect these system numbers to be the same");
7604 for (
unsigned int i = 0; i <
subspaceDim(
"NullSpace"); ++i)
7606 std::stringstream postfix;
7607 postfix <<
"_" << i;
7617 "I expect these system numbers to be the same");
7619 for (
unsigned int i = 0; i <
subspaceDim(
"TransposeNullSpace"); ++i)
7621 std::stringstream postfix;
7622 postfix <<
"_" << i;
7632 bool & changed_search_direction,
7633 bool & changed_new_soln)
7636 "I expect these system numbers to be the same");
7647 TIME_SECTION(
"computePostCheck", 2,
"Computing Post Check");
7662 std::unique_ptr<NumericVector<Number>> ghosted_solution =
7664 ghosted_search_direction =
7668 *ghosted_solution = new_soln;
7669 *ghosted_search_direction = search_direction;
7680 new_soln = old_soln;
7681 new_soln.
add(-damping, search_direction);
7682 changed_new_soln =
true;
7689 if (changed_new_soln)
7690 *ghosted_solution = new_soln;
7692 bool updated_solution =
updateSolution(new_soln, *ghosted_solution);
7693 if (updated_solution)
7694 changed_new_soln =
true;
7701 _aux->copyCurrentIntoPreviousNL();
7705 changed_search_direction =
false;
7719 TIME_SECTION(
"computeDamping", 1,
"Computing Damping");
7760 parallel_object_only();
7769 TIME_SECTION(
"updateGeometricSearch", 3,
"Updating Geometric Search");
7780 TIME_SECTION(
"updateMortarMesh", 5,
"Updating Mortar Mesh");
7789 const std::pair<BoundaryID, BoundaryID> & primary_secondary_boundary_pair,
7790 const std::pair<SubdomainID, SubdomainID> & primary_secondary_subdomain_pair,
7794 const bool correct_edge_dropping,
7795 const Real minimum_projection_angle)
7801 primary_secondary_subdomain_pair,
7806 correct_edge_dropping,
7807 minimum_projection_angle);
7810 primary_secondary_subdomain_pair,
7815 correct_edge_dropping,
7816 minimum_projection_angle);
7821 const std::pair<BoundaryID, BoundaryID> & primary_secondary_boundary_pair,
7822 const std::pair<SubdomainID, SubdomainID> & primary_secondary_subdomain_pair,
7823 bool on_displaced)
const 7826 primary_secondary_boundary_pair, primary_secondary_subdomain_pair, on_displaced);
7831 const std::pair<BoundaryID, BoundaryID> & primary_secondary_boundary_pair,
7832 const std::pair<SubdomainID, SubdomainID> & primary_secondary_subdomain_pair,
7836 primary_secondary_boundary_pair, primary_secondary_subdomain_pair, on_displaced);
7850 TIME_SECTION(
"possiblyRebuildGeomSearchPatches", 5,
"Rebuilding Geometric Search Patches");
7884 libmesh_fallthrough();
7890 _console <<
"\n\nUpdating geometric search patches\n" << std::endl;
7906 #ifdef LIBMESH_ENABLE_AMR 7915 mooseError(
"HFEM does not support mesh adaptivity currently.");
7917 TIME_SECTION(
"initialAdaptMesh", 2,
"Performing Initial Adaptivity");
7919 for (
unsigned int i = 0; i < n; i++)
7936 _console <<
"Mesh unchanged, skipping remaining steps..." << std::endl;
7952 TIME_SECTION(
"adaptMesh", 3,
"Adapting Mesh");
7956 bool mesh_changed =
false;
7958 for (
unsigned int i = 0; i < cycles_per_step; ++i)
7961 mooseError(
"HFEM does not support mesh adaptivity currently.");
7967 bool mesh_changed_this_step;
7970 if (mesh_changed_this_step)
7972 mesh_changed =
true;
7985 _console <<
"Mesh unchanged, skipping remaining steps..." << std::endl;
8001 return mesh_changed;
8003 #endif // LIBMESH_ENABLE_AMR 8017 data[tid] = &storage.getMaterialData(tid);
8024 for (
unsigned int i = 0; i <
n_threads; ++i)
8036 TIME_SECTION(
"updateMeshXFEM", 5,
"Updating XFEM");
8038 bool updated =
false;
8041 if (
_xfem->updateHeal())
8046 false,
true,
false);
8052 false,
true,
false);
8062 const bool contract_mesh,
8063 const bool clean_refinement_flags)
8065 TIME_SECTION(
"meshChanged", 3,
"Handling Mesh Changes");
8083 if (intermediate_change)
8091 if (clean_refinement_flags)
8099 if (!intermediate_change)
8162 Threads::parallel_reduce(range, pmp);
8170 for (
const auto & elem : range)
8183 Threads::parallel_reduce(range, pmp);
8187 for (
const auto & elem : range)
8190 for (
auto && child : coarsened_children)
8226 mdi->meshDisplaced();
8235 Threads::parallel_reduce(elem_range, cmt);
8237 cmt(elem_range,
true);
8243 TIME_SECTION(
"checkProblemIntegrity", 5);
8246 const auto & subdomain_names = getParam<std::vector<SubdomainName>>(
"block");
8248 std::set<SubdomainID> mesh_subdomains(mesh_subdomains_vec.begin(), mesh_subdomains_vec.end());
8254 std::set<SubdomainID>
blocks;
8257 blocks = mesh_subdomains;
8260 blocks = mesh_subdomains;
8268 "\" not found in mesh.");
8280 "\" not found in mesh.");
8284 for (
auto & nl :
_nl)
8285 nl->checkKernelCoverage(
blocks);
8290 #ifdef LIBMESH_ENABLE_AMR 8295 _console <<
"Using EXPERIMENTAL Stateful Material Property projection with Adaptivity!\n" 8300 std::set<SubdomainID> local_mesh_subs(mesh_subdomains);
8309 bool check_material_coverage =
false;
8311 for (
const auto &
id : ids)
8313 local_mesh_subs.erase(
id);
8314 check_material_coverage =
true;
8325 "Subdomain \"" + subdomain_name +
"\" not found in mesh.");
8326 local_mesh_subs.erase(
id);
8331 std::set<SubdomainID>
blocks(local_mesh_subs);
8337 "Subdomain \"" + subdomain_name +
"\" not found in mesh.");
8340 for (
const auto id :
blocks)
8341 local_mesh_subs.erase(
id);
8346 for (
auto subdomain_id : mortar_subdomain_ids)
8347 local_mesh_subs.erase(subdomain_id);
8350 if (check_material_coverage && !local_mesh_subs.empty())
8352 std::stringstream extra_subdomain_ids;
8354 std::copy(local_mesh_subs.begin(),
8355 local_mesh_subs.end(),
8356 std::ostream_iterator<unsigned int>(extra_subdomain_ids,
" "));
8358 std::vector<SubdomainID> local_mesh_subs_vec(local_mesh_subs.begin(),
8359 local_mesh_subs.end());
8361 mooseError(
"The following blocks from your input mesh do not contain an active material: " +
8362 extra_subdomain_ids.str() +
8364 ")\nWhen ANY mesh block contains a Material object, " 8365 "all blocks must contain a Material object.\n");
8375 for (
const auto & material : materials)
8376 material->checkStatefulSanity();
8396 mooseError(
"Coordinate transformation parameters, listed below, are only to be used in the " 8397 "context of application to application field transfers at this time. The mesh is " 8398 "not modified by these parameters within an application.\n" 8399 "You should likely use a 'TransformGenerator' in the [Mesh] block to achieve the " 8400 "desired mesh modification.\n\n",
8417 bool mesh_has_second_order_elements =
false;
8423 mesh_has_second_order_elements =
true;
8433 if (mesh_has_second_order_elements)
8435 const std::vector<std::string> & displacement_variables =
8438 for (
const auto & var_name : displacement_variables)
8446 mooseError(
"Error: mesh has SECOND order elements, so all displacement variables must be " 8458 std::set<SubdomainID> user_objects_blocks;
8462 std::set<std::string> names;
8464 std::vector<UserObject *> objects;
8467 for (
const auto & obj : objects)
8468 names.insert(obj->name());
8471 std::set<SubdomainID> difference;
8472 std::set_difference(user_objects_blocks.begin(),
8473 user_objects_blocks.end(),
8474 mesh_subdomains.begin(),
8475 mesh_subdomains.end(),
8476 std::inserter(difference, difference.end()));
8478 if (!difference.empty())
8480 std::ostringstream oss;
8481 oss <<
"One or more UserObjects is referencing a nonexistent block:\n";
8482 for (
const auto &
id : difference)
8490 const std::map<
SubdomainID, std::vector<std::shared_ptr<MaterialBase>>> & materials_map)
8492 for (
const auto & it : materials_map)
8495 std::set<std::string> block_depend_props, block_supplied_props;
8497 for (
const auto & mat1 : it.second)
8499 const std::set<std::string> & depend_props = mat1->getRequestedItems();
8500 block_depend_props.insert(depend_props.begin(), depend_props.end());
8502 auto & alldeps = mat1->getMatPropDependencies();
8503 for (
auto & dep : alldeps)
8505 block_depend_props.insert(*
name);
8508 for (
const auto & mat2 : it.second)
8510 const std::set<std::string> & supplied_props = mat2->MaterialBase::getSuppliedItems();
8511 block_supplied_props.insert(supplied_props.begin(), supplied_props.end());
8520 std::set<std::string> difference;
8521 std::set_difference(block_depend_props.begin(),
8522 block_depend_props.end(),
8523 block_supplied_props.begin(),
8524 block_supplied_props.end(),
8525 std::inserter(difference, difference.end()));
8527 if (!difference.empty())
8529 std::ostringstream oss;
8530 oss <<
"One or more Material Properties were not supplied on block ";
8532 if (subdomain_name.length() > 0)
8533 oss << subdomain_name <<
" (" << it.first <<
")";
8537 for (
const auto &
name : difference)
8538 oss <<
name <<
"\n";
8544 for (
const auto & it : materials_map)
8546 const auto & materials = it.second;
8547 std::set<std::string> inner_supplied, outer_supplied;
8549 for (
const auto & outer_mat : materials)
8552 outer_supplied = outer_mat->getSuppliedItems();
8553 inner_supplied.clear();
8556 std::map<std::string, std::set<std::string>> prop_to_mat;
8557 for (
const auto &
name : outer_supplied)
8558 prop_to_mat[
name].insert(outer_mat->name());
8560 for (
const auto & inner_mat : materials)
8562 if (outer_mat == inner_mat)
8566 auto outer_mat_type = outer_mat->type();
8567 auto inner_mat_type = inner_mat->type();
8572 if (outer_mat_type == inner_mat_type && outer_mat_type != outer_mat->type() &&
8573 inner_mat_type != inner_mat->type())
8576 inner_supplied.insert(inner_mat->getSuppliedItems().begin(),
8577 inner_mat->getSuppliedItems().end());
8579 for (
const auto & inner_supplied_name : inner_supplied)
8580 prop_to_mat[inner_supplied_name].insert(inner_mat->name());
8584 std::set<std::string> intersection;
8585 std::set_intersection(outer_supplied.begin(),
8586 outer_supplied.end(),
8587 inner_supplied.begin(),
8588 inner_supplied.end(),
8589 std::inserter(intersection, intersection.end()));
8591 if (!intersection.empty())
8593 std::ostringstream oss;
8594 oss <<
"The following material properties are declared on block " << it.first
8595 <<
" by multiple materials:\n";
8597 <<
"Material Objects\n";
8598 for (
const auto & outer_name : intersection)
8601 for (
const auto & inner_name : prop_to_mat[outer_name])
8602 oss << inner_name <<
" ";
8624 mooseInfo(
"Restart file ", file_name,
" is NOT being used since we are performing recovery.");
8630 mooseInfo(
"Using ", file_name,
" for restart.");
8634 std::vector<VariableName>
8637 std::vector<VariableName> names;
8641 const std::vector<VariableName> & var_names = sys->getVariableNames();
8642 names.insert(names.end(), var_names.begin(), var_names.end());
8645 const std::vector<VariableName> & aux_var_names =
_aux->getVariableNames();
8646 names.insert(names.end(), aux_var_names.begin(), aux_var_names.end());
8655 "Solver system number '" << solver_sys_num <<
"' is out of bounds. We have '" 8672 auto random_data_ptr = insert_pair.first->second.get();
8682 bnd_mat_side_cache =
false;
8684 if (
_aux->needMaterialOnSide(bnd_id))
8686 bnd_mat_side_cache =
true;
8690 for (
auto & nl :
_nl)
8691 if (nl->needBoundaryMaterialOnSide(bnd_id, tid))
8693 bnd_mat_side_cache =
true;
8704 bnd_mat_side_cache =
true;
8718 interface_mat_side_cache =
false;
8720 for (
auto & nl :
_nl)
8721 if (nl->needInterfaceMaterialOnSide(bnd_id, tid))
8723 interface_mat_side_cache =
true;
8734 interface_mat_side_cache =
true;
8739 interface_mat_side_cache =
true;
8753 for (
auto & nl :
_nl)
8754 if (nl->needSubdomainMaterialOnSide(subdomain_id, tid))
8785 mooseError(
"Previous nonlinear solution is required but not added through " 8786 "Problem/previous_nl_solution_required=true");
8803 const std::string & object_name,
8806 parallel_object_only();
8813 mooseError(
"The name '", object_name,
"' is a reserved name for output objects");
8817 if (output_warehouse.
hasOutput(object_name))
8818 mooseError(
"An output object named '", object_name,
"' already exists");
8824 std::vector<std::string> exclude;
8825 if (object_type ==
"Console")
8827 exclude.push_back(
"execute_on");
8835 else if (object_type ==
"Checkpoint")
8836 exclude.push_back(
"execute_on");
8842 if (common && std::find(exclude.begin(), exclude.end(),
"execute_on") != exclude.
end() &&
8845 "'execute_on' parameter specified in [Outputs] block is ignored for object '" +
8847 "'.\nDefine this object in its own sub-block of [Outputs] to modify its " 8848 "execution schedule.");
8851 if (object_type ==
"XDR")
8853 else if (object_type ==
"XDA")
8857 if (object_name ==
"auto_recovery_checkpoint")
8895 mooseAssert(sys_num <
_nl.size(),
"System number greater than the number of nonlinear systems");
8896 return *
_nl[sys_num];
8902 mooseAssert(sys_num <
_nl.size(),
"System number greater than the number of nonlinear systems");
8903 return *
_nl[sys_num];
8910 "System number greater than the number of linear systems");
8918 "System number greater than the number of linear systems");
8926 "System number greater than the number of solver systems");
8934 "System number greater than the number of solver systems");
8953 parallel_object_only();
8997 const std::vector<Point> *
const pts,
8998 const std::vector<Real> *
const weights,
9010 unsigned int neighbor_side,
9012 const std::vector<Point> *
const pts,
9013 const std::vector<Real> *
const weights,
9026 std::vector<std::shared_ptr<MaterialBase>> & face_materials,
9027 std::vector<std::shared_ptr<MaterialBase>> & neighbor_materials,
9028 std::set<MooseVariableFieldBase *> & variables,
9033 auto & this_face_mats =
9035 for (std::shared_ptr<MaterialBase> face_mat : this_face_mats)
9036 if (face_mat->ghostable())
9038 face_materials.push_back(face_mat);
9039 auto & var_deps = face_mat->getMooseVariableDependencies();
9040 for (
auto * var : var_deps)
9044 "Ghostable materials should only have finite volume variables coupled into them.");
9045 else if (face_mat->hasStatefulProperties())
9046 mooseError(
"Finite volume materials do not currently support stateful properties.");
9047 variables.insert(var);
9054 auto & this_neighbor_mats =
9056 for (std::shared_ptr<MaterialBase> neighbor_mat : this_neighbor_mats)
9057 if (neighbor_mat->ghostable())
9059 neighbor_materials.push_back(neighbor_mat);
9061 auto & var_deps = neighbor_mat->getMooseVariableDependencies();
9062 for (
auto * var : var_deps)
9066 "Ghostable materials should only have finite volume variables coupled into them.");
9067 else if (neighbor_mat->hasStatefulProperties())
9068 mooseError(
"Finite volume materials do not currently support stateful properties.");
9069 auto pr = variables.insert(var);
9070 mooseAssert(!pr.second,
9071 "We should not have inserted any new variables dependencies from our " 9072 "neighbor materials that didn't exist for our face materials");
9081 const unsigned int nqp,
9092 "There must be one convergence object per nonlinear system");
9108 const std::vector<ConvergenceName> &
9113 mooseError(
"The nonlinear system convergence name(s) have not been set.");
9128 paramError(
"linear_convergence",
"There must be one convergence object per linear system");
9132 const std::vector<ConvergenceName> &
9137 mooseError(
"The linear convergence name(s) have not been set.");
9140 const ConvergenceName &
9146 mooseError(
"The fixed point convergence name has not been set.");
9149 const ConvergenceName &
9155 mooseError(
"The steady convergence name has not been set.");
9166 _nl[i]->residualSetup();
9180 _nl[i]->jacobianSetup();
9200 return current_nl_sys_num;
9211 return current_linear_sys_num;
9228 std::vector<MortarUserObject *>
9231 const bool displaced,
9232 const std::vector<MortarUserObject *> & mortar_uo_superset)
9234 std::vector<MortarUserObject *> mortar_uos;
9236 : static_cast<SubProblem *>(
this);
9237 for (
auto *
const obj : mortar_uo_superset)
9238 if (obj->onInterface(primary_boundary_id, secondary_boundary_id) &&
9239 (&obj->getSubProblem() == subproblem))
9240 mortar_uos.push_back(obj);
9245 std::vector<MortarUserObject *>
9248 const bool displaced)
9250 std::vector<MortarUserObject *> mortar_uos;
9254 .queryInto(mortar_uos);
9255 return getMortarUserObjects(primary_boundary_id, secondary_boundary_id, displaced, mortar_uos);
9261 const bool displaced)
9263 const auto mortar_uos =
9265 for (
auto *
const mortar_uo : mortar_uos)
9267 mortar_uo->setNormals();
9268 mortar_uo->reinit();
9300 mooseAssert(nl_sys_num <
_nl.size(),
9301 "System number greater than the number of nonlinear systems");
9310 "System number greater than the number of linear systems");
9323 solver_sys->compute(
type);
9405 return solver_params;
bool _reinit_displaced_elem
Whether to call DisplacedProblem::reinitElem when this->reinitElem is called.
This class determines the maximum number of Quadrature Points and Shape Functions used for a given si...
virtual void addInterfaceMaterial(const std::string &material_name, const std::string &name, InputParameters ¶meters)
std::map< NonlinearSystemName, unsigned int > _nl_sys_name_to_num
Map from nonlinear system name to number.
void setCurrentAlgebraicElementRange(libMesh::ConstElemRange *range)
These functions allow setting custom ranges for the algebraic elements, nodes, and boundary nodes tha...
std::string indent(unsigned int spaces)
Create empty string for indenting.
std::vector< Point > _point_zero
Interface for objects that need parallel consistent random numbers without patterns over the course o...
void updateVariableDependency(std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
Update variable dependency vector.
virtual void addCachedResidual(const THREAD_ID tid)
virtual void computeJacobianTag(const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, TagID tag)
Form a Jacobian matrix for a given tag.
void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.
unsigned short getCurrentICState()
Retrieves the current initial condition state.
virtual void addFVInitialCondition(const std::string &ic_name, const std::string &name, InputParameters ¶meters)
Add an initial condition for a finite volume variables.
bool adaptMesh(std::string marker_name=std::string())
Adapts the mesh based on the error estimator used.
void sort(THREAD_ID tid=0)
Sort the objects using the DependencyResolver.
virtual void addMaterialHelper(std::vector< MaterialWarehouse *> warehouse, const std::string &material_name, const std::string &name, InputParameters ¶meters)
bool initialAdaptMesh()
Used during initial adaptivity.
virtual void residualSetup(THREAD_ID tid=0) const
virtual bool hasVariable(const std::string &var_name) const override
Whether or not this problem has the variable.
virtual void stopSolve(const ExecFlagType &exec_flag, const std::set< TagID > &vector_tags_to_close) override
Quit the current solve as soon as possible.
bool hasInvalidSolutionError() const
Whether or not an invalid solution was encountered that was an error.
void setActiveMaterialProperties(const std::unordered_set< unsigned int > &mat_prop_ids, const THREAD_ID tid)
Record and set the material properties required by the current computing thread.
const bool _regard_general_exceptions_as_errors
If we catch an exception during residual/Jacobian evaluaton for which we don't have specific handling...
const std::size_t _num_nl_sys
The number of nonlinear systems.
void setVariableAllDoFMap(const std::vector< const MooseVariableFEBase *> &moose_vars)
void computeJacobianBlocks(std::vector< JacobianBlock *> &blocks)
Computes several Jacobian blocks simultaneously, summing their contributions into smaller preconditio...
virtual void initPetscOutputAndSomeSolverSettings()
Reinitialize PETSc output for proper linear/nonlinear iteration display.
const std::vector< ConvergenceName > & getNonlinearConvergenceNames() const
Gets the nonlinear system convergence object name(s).
MetaPhysicL::DualNumber< V, D, asd > abs(const MetaPhysicL::DualNumber< V, D, asd > &a)
void timestepSetup() override
virtual void addSampler(const std::string &type, const std::string &name, InputParameters ¶meters)
The following functions will enable MOOSE to have the capability to import Samplers.
bool _skip_exception_check
If or not skip 'exception and stop solve'.
const std::vector< std::string > & get_global_var_names()
bool isFiniteVolumeInfoDirty() const
Helper class for holding the preconditioning blocks to fill.
virtual void restore_original_nonzero_pattern()
bool _reinit_displaced_neighbor
Whether to call DisplacedProblem::reinitNeighbor when this->reinitNeighbor is called.
virtual void clearActiveFEVariableCoupleableMatrixTags(const THREAD_ID tid)
void outputStep(ExecFlagType type)
Calls the outputStep method for each output object.
virtual void meshChanged()
Deprecated.
virtual void addDamper(const std::string &damper_name, const std::string &name, InputParameters ¶meters)
std::map< LinearSystemName, unsigned int > _linear_sys_name_to_num
Map from linear system name to number.
virtual void clearActiveFEVariableCoupleableVectorTags(const THREAD_ID tid)
libMesh::ConstElemRange * getActiveLocalElementRange()
Return pointers to range objects for various types of ranges (local nodes, boundary elems...
void getFVMatsAndDependencies(SubdomainID block_id, std::vector< std::shared_ptr< MaterialBase >> &face_materials, std::vector< std::shared_ptr< MaterialBase >> &neighbor_materials, std::set< MooseVariableFieldBase *> &variables, const THREAD_ID tid)
Get the materials and variables potentially needed for FV.
std::vector< MooseArray< ADRealTensorValue > > _ad_second_zero
bool _have_ad_objects
AD flag indicating whether any AD objects have been added.
void shift()
Shift the material properties in time.
virtual void prepareFace(const Elem *elem, const THREAD_ID tid) override
Base class for function objects.
void setPreserveMatrixSparsityPattern(bool preserve)
Set whether the sparsity pattern of the matrices being formed during the solve (usually the Jacobian)...
void reinitBecauseOfGhostingOrNewGeomObjects(bool mortar_changed=false)
Call when it is possible that the needs for ghosted elements has changed.
void fill_data(std::map< processor_id_type, std::vector< std::set< unsigned int >>> &data, int M)
virtual void addTransfer(const std::string &transfer_name, const std::string &name, InputParameters ¶meters)
Add a Transfer to the problem.
virtual libMesh::System & getSystem(const std::string &var_name) override
Returns the equation system containing the variable provided.
virtual void setActiveScalarVariableCoupleableMatrixTags(std::set< TagID > &mtags, const THREAD_ID tid)
A MultiMooseEnum object to hold "execute_on" flags.
static SolverParams makeLinearSolverParams()
Make basic solver params for linear solves.
bool _parallel_barrier_messaging
Whether or not information about how many transfers have completed is printed.
MooseVariableFieldBase & getVariableHelper(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type, Moose::VarFieldType expected_var_field_type, const std::vector< T > &nls, const SystemBase &aux) const
Helper function called by getVariable that handles the logic for checking whether Variables of the re...
virtual void addResidualLower(const THREAD_ID tid) override
A class for creating restricted objects.
bool isUltimateMaster() const
Whether or not this app is the ultimate master app.
virtual void addJacobianLowerD(const THREAD_ID tid) override
Factory & _factory
The Factory for building objects.
virtual void clearActiveScalarVariableCoupleableVectorTags(const THREAD_ID tid) override
MaterialPropertyStorage & _bnd_material_props
virtual void addGhostedElem(dof_id_type elem_id) override
Will make sure that all dofs connected to elem_id are ghosted to this processor.
void setNonlocalCouplingMatrix()
Set custom coupling matrix for variables requiring nonlocal contribution.
Threads::spin_mutex get_function_mutex
void initialSetup()
Calls the initialSetup function for each of the output objects.
virtual Real & time() const
virtual const char * what() const
Get out the error message.
std::vector< std::pair< MooseVariableFEBase *, MooseVariableFEBase * > > & couplingEntries(const THREAD_ID tid, const unsigned int nl_sys_num)
const Variable & variable(unsigned int var) const
void checkDependMaterialsHelper(const std::map< SubdomainID, std::vector< std::shared_ptr< MaterialBase >>> &materials_map)
Helper method for checking Material object dependency.
void extraSparsity(libMesh::SparsityPattern::Graph &sparsity, std::vector< dof_id_type > &n_nz, std::vector< dof_id_type > &n_oz, void *context)
Free function used for a libMesh callback.
virtual void cacheResidualNeighbor(const THREAD_ID tid) override
ExecFlagType _current_execute_on_flag
Current execute_on flag.
const std::set< SubdomainID > & interiorLowerDBlocks() const
void clearCurrentResidualVectorTags()
Clear the current residual vector tag data structure.
bool hasActiveBlockObjects(THREAD_ID tid=0) const
QueryCache is a convenient way to construct and pass around (possible partially constructed) warehous...
std::shared_ptr< DisplacedProblem > displaced_problem
const unsigned int invalid_uint
virtual void reinitLowerDElem(const Elem *lower_d_elem, const THREAD_ID tid, const std::vector< Point > *const pts=nullptr, const std::vector< Real > *const weights=nullptr)
RelationshipManagerType
Main types of Relationship Managers.
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
unsigned int get_node_index(const Node *node_ptr) const
virtual void checkExceptionAndStopSolve(bool print_message=true)
Check to see if an exception has occurred on any processor and, if possible, force the solve to fail...
virtual void meshDisplaced()
Update data after a mesh displaced.
const std::set< BoundaryID > & getSubdomainBoundaryIds(const SubdomainID subdomain_id) const
Get the list of boundary ids associated with the given subdomain id.
void mooseDeprecated(Args &&... args) const
std::optional< ConvergenceName > _multiapp_fixed_point_convergence_name
MultiApp fixed point convergence name.
const std::string & name() const
MooseAppCoordTransform & coordTransform()
virtual void setActiveFEVariableCoupleableMatrixTags(std::set< TagID > &mtags, const THREAD_ID tid) override
void setCurrentAlgebraicNodeRange(libMesh::ConstNodeRange *range)
void setResidualObjectParamsAndLog(const std::string &ro_name, const std::string &name, InputParameters ¶ms, const unsigned int nl_sys_num, const std::string &base_name, bool &reinit_displaced)
Set the subproblem and system parameters for residual objects and log their addition.
const AutomaticMortarGeneration & getMortarInterface(const std::pair< BoundaryID, BoundaryID > &boundary_key, const std::pair< SubdomainID, SubdomainID > &, bool on_displaced) const
Getter to retrieve the AutomaticMortarGeneration object corresponding to the boundary and subdomain k...
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
Real computeDamping(const NumericVector< Number > &solution, const NumericVector< Number > &update)
Compute damping.
virtual void reinitNode(const Node *node, const THREAD_ID tid) override
virtual std::size_t numNonlinearSystems() const override
Base class for implementing interface user objects.
virtual void setPreviousNewtonSolution(const NumericVector< Number > &soln)
virtual void predictorCleanup(NumericVector< libMesh::Number > &ghosted_solution)
Perform cleanup tasks after application of predictor to solution vector.
virtual void prepare(const Elem *elem, const THREAD_ID tid) override
TagID rightHandSideVectorTag() const
virtual Elem * elemPtr(const dof_id_type i)
TagID systemMatrixTag() const override
Return the Matrix Tag ID for System.
NumericVector< Number > & solution()
bool hasObjects(THREAD_ID tid=0) const
Convenience functions for determining if objects exist.
bool _has_jacobian
Indicates if the Jacobian was computed.
virtual bool haveFV() const override
returns true if this problem includes/needs finite volume functionality.
Interface for objects acting when the mesh has been displaced.
static void uniformRefine(MooseMesh *mesh, unsigned int level=libMesh::invalid_uint)
Performs uniform refinement of the passed Mesh object.
bool _has_dampers
Whether or not this system has any Dampers associated with it.
MooseObjectWarehouse< InternalSideIndicatorBase > _internal_side_indicators
std::vector< SubdomainName > _kernel_coverage_blocks
const std::map< dof_id_type, std::vector< dof_id_type > > & nodeToActiveSemilocalElemMap()
If not already created, creates a map from every node to all active semilocal elements to which they ...
virtual Distribution & getDistribution(const std::string &name)
void swapBack(const Elem &elem, unsigned int side=0)
material properties for given element (and possible side)
bool _has_nonlocal_coupling
Indicates if nonlocal coupling is required/exists.
void setCurrentAlgebraicBndNodeRange(ConstBndNodeRange *range)
This is the base class for Samplers as used within the Stochastic Tools module.
Base class for predictors.
bool areCoupled(const unsigned int ivar, const unsigned int jvar, const unsigned int nl_sys_num) const
Moose::LineSearchType _line_search
void setPostprocessorValueByName(const PostprocessorName &name, const PostprocessorValue &value, std::size_t t_index=0)
Set the value of a PostprocessorValue.
virtual void clearActiveScalarVariableCoupleableMatrixTags(const THREAD_ID tid) override
virtual void postExecute()
Method called at the end of the simulation.
void reinit(bool reinit_for_derivative_reordering=false)
Fill out the VariableValue arrays from the system solution vector.
std::shared_ptr< CommandLine > commandLine() const
Get the command line.
unsigned int number() const
Get variable number coming from libMesh.
void eraseProperty(const Elem *elem)
Remove the property storage and element pointer from internal data structures Use this when elements ...
bool isSolverSystemNonlinear(const unsigned int sys_num)
Check if the solver system is nonlinear.
void petscSetDefaults(FEProblemBase &problem)
Sets the default options for PETSc.
std::unordered_set< TagID > _not_zeroed_tagged_vectors
the list of vector tags that will not be zeroed when all other tags are
void joinAndFinalize(TheWarehouse::Query query, bool isgen=false)
bool hasInitialBackup() const
std::vector< MooseArray< ADRealVectorValue > > _ad_grad_zero
std::vector< SolverParams > _solver_params
InputParameterWarehouse & getInputParameterWarehouse()
Get the InputParameterWarehouse for MooseObjects.
void mooseInfo(Args &&... args) const
ExecuteMooseObjectWarehouse< Control > _control_warehouse
The control logic warehouse.
void updateActive(THREAD_ID tid=0) override
Updates the active objects storage.
virtual std::pair< bool, unsigned int > determineSolverSystem(const std::string &var_name, bool error_if_not_found=false) const override
Determine what solver system the provided variable name lies in.
std::unique_ptr< libMesh::ConstNodeRange > _current_algebraic_node_range
virtual void setActiveScalarVariableCoupleableMatrixTags(std::set< TagID > &mtags, const THREAD_ID tid) override
void setCoupling(Moose::CouplingType type)
Set the coupling between variables TODO: allow user-defined coupling.
constexpr std::size_t constMaxQpsPerElem
This is used for places where we initialize some qp-sized data structures that would end up being siz...
const ExecFlagType & getCurrentExecuteOnFlag() const
Return/set the current execution flag.
unsigned int _cycles_completed
bool _currently_computing_jacobian
Flag to determine whether the problem is currently computing Jacobian.
virtual void reinitScalars(const THREAD_ID tid, bool reinit_for_derivative_reordering=false) override
fills the VariableValue arrays for scalar variables from the solution vector
const ExecFlagEnum & getExecuteOnEnum() const
Return the app level ExecFlagEnum, this contains all the available flags for the app.
virtual void init() override
void add(std::shared_ptr< MooseObject > obj)
add adds a new object to the warehouse and stores attributes/metadata about it for running queries/fi...
void translateMetaPhysicLError(const MetaPhysicL::LogicError &)
emit a relatively clear error message when we catch a MetaPhysicL logic error
virtual void getDiracElements(std::set< const Elem *> &elems) override
Fills "elems" with the elements that should be looped over for Dirac Kernels.
virtual void setActiveElementalMooseVariables(const std::set< MooseVariableFieldBase *> &moose_vars, const THREAD_ID tid)
Set the MOOSE variables to be reinited on each element.
void parentOutputPositionChanged()
Calls parentOutputPositionChanged() on all sub apps.
void setupDM()
Setup the PETSc DM object (when appropriate)
virtual void setCurrentBoundaryID(BoundaryID bid, const THREAD_ID tid)
sets the current boundary ID in assembly
virtual void addInterfaceKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual void neighborSubdomainSetup(THREAD_ID tid=0) const
libMesh::LinearImplicitSystem & linearImplicitSystem()
Return a reference to the stored linear implicit system.
bool _is_petsc_options_inserted
If or not PETSc options have been added to database.
void setCurrentlyComputingResidual(bool currently_computing_residual) final
Set whether or not the problem is in the process of computing the residual.
virtual void addMaterial(const std::string &material_name, const std::string &name, InputParameters ¶meters)
virtual void lineSearch()
execute MOOSE line search
const std::vector< T > & getSortedValues()
This function also returns dependency resolved values but with a simpler single vector interface...
unsigned int getCyclesPerStep() const
Pull out the number of cycles_per_step previously set through the AdaptivityAction.
virtual void setCurrentLowerDElem(const Elem *const lower_d_elem, const THREAD_ID tid)
Set the current lower dimensional element.
const Elem * getLowerDElem(const Elem *, unsigned short int) const
Returns a const pointer to a lower dimensional element that corresponds to a side of a higher dimensi...
NonlocalIntegratedBC is used for solving integral terms in integro-differential equations.
virtual bool checkNonlocalCouplingRequirement() const override
virtual bool uDotDotRequested()
Get boolean flag to check whether solution second time derivative needs to be stored.
void updateErrorVectors()
Update the ErrorVectors that have been requested through calls to getErrorVector().
unsigned short _current_ic_state
virtual void reinitNeighborPhys(const Elem *neighbor, unsigned int neighbor_side, const std::vector< Point > &physical_points, const THREAD_ID tid) override
virtual TagID addVectorTag(const TagName &tag_name, const Moose::VectorTagType type=Moose::VECTOR_TAG_RESIDUAL)
Create a Tag.
std::vector< MeshDisplacedInterface * > _notify_when_mesh_displaces
Objects to be notified when the mesh displaces.
std::vector< T * > & queryInto(std::vector< T *> &results, Args &&... args)
queryInto executes the query and stores the results in the given vector.
void trustUserCouplingMatrix()
Whether to trust the user coupling matrix even if we want to do things like be paranoid and create a ...
virtual void newAssemblyArray(std::vector< std::shared_ptr< SolverSystem >> &solver_systems)
const bool _uo_aux_state_check
Whether or not checking the state of uo/aux evaluation.
virtual const std::set< MooseVariableFieldBase * > & getActiveElementalMooseVariables(const THREAD_ID tid) const
Get the MOOSE variables to be reinited on each element.
This is a template class that implements the workhorse compute and computeNodal methods.
virtual void addMeshDivision(const std::string &type, const std::string &name, InputParameters ¶ms)
Add a MeshDivision.
const ExecFlagType EXEC_NONE
A struct for storing the various types of petsc options and values.
virtual void computeMarkers()
void reportMooseObjectDependency(MooseObject *a, MooseObject *b)
Register a MOOSE object dependency so we can either order operations properly or report when we canno...
void residualSetup() override
MaterialDataType
MaterialData types.
void computeUserObjectsInternal(const ExecFlagType &type, const Moose::AuxGroup &group, TheWarehouse::Query &query)
TagID nonTimeVectorTag() const override
A class for "pretty printing" a table of data.
virtual void addCachedJacobian(const THREAD_ID tid)
const std::string & getBoundaryName(BoundaryID boundary_id)
Return the name of the boundary given the id.
void cacheChangedLists()
Cache information about what elements were refined and coarsened in the previous step.
virtual void residualSetup()
Positions objects are under the hood Reporters.
void reinitMortarUserObjects(BoundaryID primary_boundary_id, BoundaryID secondary_boundary_id, bool displaced)
Call reinit on mortar user objects with matching primary boundary ID, secondary boundary ID...
virtual TagID systemMatrixTag() const override
Return the Matrix Tag ID for System.
virtual void associateVectorToTag(NumericVector< Number > &vec, TagID tag)
Associate a vector for a given tag.
virtual void reinitNodes(const std::vector< dof_id_type > &nodes, const THREAD_ID tid) override
virtual void updateActiveObjects()
Update the active objects in the warehouses.
Stores the stateful material properties computed by materials.
virtual void computeIndicatorsAndMarkers()
void reinitMaterialsBoundary(BoundaryID boundary_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase *> *reinit_mats=nullptr)
reinit materials on a boundary
virtual void addJacobianOffDiagScalar(unsigned int ivar, const THREAD_ID tid=0)
virtual void setException(const std::string &message)
Set an exception, which is stored at this point by toggling a member variable in this class...
virtual void addJacobian(const THREAD_ID tid) override
void addFunctor(const std::string &name, const Moose::FunctorBase< T > &functor, const THREAD_ID tid)
add a functor to the problem functor container
virtual libMesh::System & system()=0
Get the reference to the libMesh system.
std::filesystem::path restartFolderBase(const std::filesystem::path &folder_base) const
The file suffix for restartable data.
virtual void addAuxScalarKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual void customSetup(const ExecFlagType &exec_type, THREAD_ID tid=0) const
bool isReservedName(const std::string &name)
Test if the given name is reserved.
bool globalADIndexing()
Whether we are using global AD indexing.
bool hasOutput(const std::string &name) const
Returns true if the output object exists.
Base class for MOOSE-based applications.
void disable_refine_in_reinit()
void mooseInfoRepeated(Args &&... args)
Emit an informational message with the given stringified, concatenated args.
PetscOptions _petsc_option_data_base
bool needBoundaryMaterialOnSide(BoundaryID bnd_id, const THREAD_ID tid)
These methods are used to determine whether stateful material properties need to be stored on interna...
virtual const std::vector< VectorTag > & currentResidualVectorTags() const override
Return the residual vector tags we are currently computing.
processor_id_type rank() const
std::vector< SubdomainName > _material_coverage_blocks
bool computingScalingJacobian() const
Whether we are computing an initial Jacobian for automatic variable scaling.
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
NumericVector< Number > * rhs
void setSteadyStateConvergenceName(const ConvergenceName &convergence_name)
Sets the steady-state detection convergence object name if there is one.
virtual void addAuxScalarVariable(const std::string &var_name, libMesh::Order order, Real scale_factor=1., const std::set< SubdomainID > *const active_subdomains=NULL)
virtual const SystemBase & systemBaseLinear(unsigned int sys_num) const override
Get a constant base class reference to a linear system.
const Parallel::Communicator & comm() const
void logAdd(const std::string &system, const std::string &name, const std::string &type, const InputParameters ¶ms) const
Output information about the object just added to the problem.
virtual bool hasScalarVariable(const std::string &var_name) const override
Returns a Boolean indicating whether any system contains a variable with the name provided...
void setSolution(const NumericVector< Number > &soln)
Set the solution to a given vector.
MultiApp Implementation for Transient Apps.
Solving a linear problem.
void resizeMaterialData(Moose::MaterialDataType data_type, unsigned int nqp, const THREAD_ID tid)
Resize material data.
void finishMultiAppStep(ExecFlagType type, bool recurse_through_multiapp_levels=false)
Finish the MultiApp time step (endStep, postStep) associated with the ExecFlagType.
virtual void addFunctorMaterial(const std::string &functor_material_name, const std::string &name, InputParameters ¶meters)
virtual void timestepSetup(THREAD_ID tid=0) const
std::vector< VariableSecond > _second_zero
void clean_refinement_flags()
std::map< SolverVariableName, unsigned int > _solver_var_to_sys_num
Map connecting variable names with their respective solver systems.
virtual std::unique_ptr< NumericVector< T > > clone() const=0
std::vector< MooseArray< ADReal > > _ad_zero
void customSetup(const ExecFlagType &exec_type)
Calls the setup function for each of the output objects.
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
bool _requires_nonlocal_coupling
nonlocal coupling requirement flag
virtual void onTimestepEnd() override
virtual void computeNearNullSpace(libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > *> &sp)
virtual void addNodalKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
std::vector< std::shared_ptr< SolverSystem > > _solver_systems
Combined container to base pointer of every solver system.
MaterialData & getMaterialData(Moose::MaterialDataType type, const THREAD_ID tid=0) const
All Distributions should inherit from this class.
void setCurrentDirection(const int direction)
Set this Transfer to be executed in a given direction.
std::unique_ptr< T_DEST, T_DELETER > dynamic_pointer_cast(std::unique_ptr< T_SRC, T_DELETER > &src)
These are reworked from https://stackoverflow.com/a/11003103.
ConstElemPointerRange * refinedElementRange() const
Return a range that is suitable for threaded execution over elements that were just refined...
std::vector< VectorVariableCurl > _vector_curl_zero
static void selectVectorTagsFromSystem(const SystemBase &system, const std::vector< VectorTag > &input_vector_tags, std::set< TagID > &selected_tags)
Select the vector tags which belong to a specific system.
Base class for user objects executed one or more sidesets, which may be on the outer boundary of the ...
bool _has_exception
Whether or not an exception has occurred.
unsigned int _num_grid_steps
Number of steps in a grid sequence.
virtual void associateMatrixToTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Associate a matrix to a tag.
bool haveXFEM()
Find out whether the current analysis is using XFEM.
virtual void addJacobianBlockTags(libMesh::SparseMatrix< libMesh::Number > &jacobian, unsigned int ivar, unsigned int jvar, const DofMap &dof_map, std::vector< dof_id_type > &dof_indices, const std::set< TagID > &tags, const THREAD_ID tid)
void registerRandomInterface(RandomInterface &random_interface, const std::string &name)
bool _has_time_integrator
Indicates whether or not this executioner has a time integrator (during setup)
This class provides an interface for common operations on field variables of both FE and FV types wit...
const Parallel::Communicator & _communicator
virtual void addAuxKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual void jacobianSetup()
void clearActiveMaterialProperties(const THREAD_ID tid)
Clear the active material properties.
virtual unsigned int nLinearIterations(const unsigned int nl_sys_num) const override
std::vector< subdomain_id_type > getSubdomainIDs(const libMesh::MeshBase &mesh, const std::vector< SubdomainName > &subdomain_name)
Get the associated subdomainIDs for the subdomain names that are passed in.
ExecuteMooseObjectWarehouse< TransientMultiApp > _transient_multi_apps
Storage for TransientMultiApps (only needed for calling 'computeDT')
bool hasUserObject(const std::string &name) const
Check if there if a user object of given name.
MaterialWarehouse _interface_materials
Real getStartTime() const
Thread to compute threaded general user objects.
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
bool _ignore_zeros_in_jacobian
Whether to ignore zeros in the Jacobian, thereby leading to a reduced sparsity pattern.
const libMesh::ConstElemRange & getCurrentAlgebraicElementRange()
These are the element and nodes that contribute to the jacobian and residual for this local processor...
void setup(const ExecFlagType &exec_flag, THREAD_ID tid=0) const
void setCurrentExecuteOnFlag(const ExecFlagType &)
virtual void computeResidualInternal(const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, const std::set< TagID > &tags)
Form a residual vector for a set of tags.
void copyValuesBack()
Copies current chain control data values into old values.
void initElementStatefulProps(const libMesh::ConstElemRange &elem_range, const bool threaded)
Initialize stateful properties for elements in a specific elem_range This is needed when elements/bou...
const libMesh::ConstNodeRange & getCurrentAlgebraicNodeRange()
void setCurrentlyComputingResidualAndJacobian(bool currently_computing_residual_and_jacobian)
Set whether or not the problem is in the process of computing the Jacobian.
ExecuteMooseObjectWarehouse< Transfer > _from_multi_app_transfers
Transfers executed just after MultiApps to transfer data from them.
virtual void addKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
libMesh::TensorValue< ADReal > ADRealTensorValue
Base class for a system (of equations)
const ExecFlagType EXEC_ALWAYS
SparseMatrix< Number > & getSystemMatrix()
Fetching the system matrix from the libmesh system.
This user object allows related evaluations on elements, boundaries, internal sides, interfaces in one single place.
virtual void addAuxVariable(const std::string &var_type, const std::string &var_name, InputParameters ¶ms)
Canonical method for adding an auxiliary variable.
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).
const T_sys & get_system(std::string_view name) const
std::optional< ConvergenceName > _steady_state_convergence_name
Steady-state detection convergence name.
Base class for MeshDivision objects.
bool computingNonlinearResid() const
Returns true if the problem is in the process of computing the nonlinear residual.
virtual void addFVInterfaceKernel(const std::string &fv_ik_name, const std::string &name, InputParameters ¶meters)
MeshDivision & getMeshDivision(const std::string &name, const THREAD_ID tid=0) const
Get a MeshDivision.
bool isRestarting() const
Whether or not this is a "restart" calculation.
Base class for creating new nodally-based mortar user objects.
Reporter objects allow for the declaration of arbitrary data types that are aggregate values for a si...
const Positions & getPositionsObject(const std::string &name) const
Get the Positions object by its name.
libMesh::ConstNodeRange * getLocalNodeRange()
std::map< SolverSystemName, unsigned int > _solver_sys_name_to_num
Map connecting solver system names with their respective systems.
FEProblemBase(const InputParameters ¶meters)
void addEdge(const T &a, const T &b)
Add an edge between nodes 'a' and 'b'.
std::string convertLatestCheckpoint(std::string orig)
Replaces "LATEST" placeholders with the latest checkpoint file name.
bool isOn()
Is adaptivity on?
void computeResidualTags(const std::set< TagID > &tags)
Form multiple tag-associated residual vectors for all the given tags.
virtual void cacheJacobianNeighbor(const THREAD_ID tid) override
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
virtual void clearActiveElementalMooseVariables(const THREAD_ID tid)
Clear the active elemental MooseVariableFieldBase.
std::vector< std::unordered_map< BoundaryID, bool > > _bnd_mat_side_cache
Cache for calculating materials on side.
bool hasLinearConvergenceObjects() const
Whether we have linear convergence objects.
virtual const Node & nodeRef(const dof_id_type i) const
std::set< dof_id_type > _ghosted_elems
Elements that should have Dofs ghosted to the local processor.
ExecFlagEnum _print_execution_on
When to print the execution of loops.
virtual const std::string & name() const
Get the name of the class.
std::vector< SubdomainID > getSubdomainIDs(const std::vector< SubdomainName > &subdomain_names) const
Get the associated subdomainIDs for the subdomain names that are passed in.
void clearAllDofIndices()
Clear dof indices from variables in nl and aux systems.
virtual void setResidual(NumericVector< libMesh::Number > &residual, const THREAD_ID tid) override
virtual void solve(const unsigned int nl_sys_num)
virtual void setCurrentLowerDElem(const Elem *const lower_d_elem, const THREAD_ID tid) override
Set the current lower dimensional element.
void mooseWarning(Args &&... args) const
Emits a warning prefixed with object name and type.
std::set< TagID > _linear_matrix_tags
Temporary storage for filtered matrix tags for linear systems.
MooseApp & getMooseApp() const
Get the MooseApp this class is associated with.
void bumpAllQRuleOrder(libMesh::Order order, SubdomainID block)
Real computeMultiAppsDT(ExecFlagType type)
Find the smallest timestep over all MultiApps.
const std::string & getSubdomainName(SubdomainID subdomain_id) const
Return the name of a block given an id.
virtual void reinitNeighborFaceRef(const Elem *neighbor_elem, unsigned int neighbor_side, Real tolerance, const std::vector< Point > *const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0)
reinitialize FE objects on a given neighbor element on a given side at a given set of reference point...
virtual const MooseVariableFieldBase & getVariable(const THREAD_ID tid, const std::string &var_name, Moose::VarKindType expected_var_type=Moose::VarKindType::VAR_ANY, Moose::VarFieldType expected_var_field_type=Moose::VarFieldType::VAR_FIELD_ANY) const override
Returns the variable reference for requested variable which must be of the expected_var_type (Nonline...
void reinitMaterialsFace(SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase *> *reinit_mats=nullptr)
reinit materials on element faces
std::unique_ptr< libMesh::ConstElemRange > _nl_evaluable_local_elem_range
virtual void disassociateMatrixFromTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Disassociate a matrix from a tag.
void projectInitialConditionOnCustomRange(libMesh::ConstElemRange &elem_range, ConstBndNodeRange &bnd_node_range)
Project initial conditions for custom elem_range and bnd_node_range This is needed when elements/boun...
Scope guard for starting and stopping Floating Point Exception Trapping.
virtual void computeResidualTags(const std::set< TagID > &tags)
Form multiple residual vectors and each is associated with one tag.
void forceOutput()
Indicates that the next call to outputStep should be forced This is private, users should utilize FEP...
virtual void computeJacobianSys(libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian)
Form a Jacobian matrix.
auto max(const L &left, const R &right)
std::shared_ptr< MultiApp > getMultiApp(const std::string &multi_app_name) const
Get a MultiApp object by name.
ExecuteMooseObjectWarehouse< UserObject > _all_user_objects
virtual void reinitElemNeighborAndLowerD(const Elem *elem, unsigned int side, const THREAD_ID tid) override
bool hasSolverVariable(const std::string &var_name) const
void preparePRefinement()
Prepare DofMap and Assembly classes with our p-refinement information.
AuxGroup
Flag for AuxKernel related execution type.
virtual Elem * queryElemPtr(const dof_id_type i)
virtual void addMarker(const std::string &marker_name, const std::string &name, InputParameters ¶meters)
void updateGhostedElems()
Updates the list of ghosted elements at the start of each time step for the nonlinear iteration patch...
unsigned int subspaceDim(const std::string &prefix) const
Dimension of the subspace spanned by vectors with a given prefix.
elem_info_iterator ownedElemInfoBegin()
Iterators to owned faceInfo objects.
void setCurrentlyComputingJacobian(const bool currently_computing_jacobian)
Set whether or not the problem is in the process of computing the Jacobian.
unsigned int variable_number(std::string_view var) const
const std::unordered_map< std::pair< BoundaryID, BoundaryID >, AutomaticMortarGeneration > & getMortarInterfaces(bool on_displaced) const
Return all automatic mortar generation objects on either the displaced or undisplaced mesh...
A ReporterName that represents a VectorPostprocessor.
bool needsPreviousNewtonIteration() const
Check to see whether we need to compute the variable values of the previous Newton iterate...
virtual void addBoundaryCondition(const std::string &bc_name, const std::string &name, InputParameters ¶meters)
bool _computing_nonlinear_residual
Whether the non-linear residual is being evaluated.
virtual bool computingPreSMOResidual(const unsigned int nl_sys_num) const override
Returns true if the problem is in the process of computing it's initial residual. ...
void update()
Update the system (doing libMesh magic)
This class is a container/interface for the objects involved in automatic generation of mortar spaces...
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num) override
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
const bool _skip_nl_system_check
virtual void resetState()
Reset state of this object in preparation for the next evaluation.
void jacobianSetup()
Calls the jacobianSetup function for each of the output objects.
virtual void addInitialCondition(const std::string &ic_name, const std::string &name, InputParameters ¶meters)
virtual void addCachedResidualDirectly(NumericVector< libMesh::Number > &residual, const THREAD_ID tid)
Allows for all the residual contributions that are currently cached to be added directly into the vec...
bool hasObjects() const
Returns whether we have any active AutomaticMortarGeneration objects.
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
virtual void jacobianSetup(THREAD_ID tid=0) const
const SubdomainID INVALID_BLOCK_ID
ScalarInitialConditionWarehouse _scalar_ics
virtual void computeLinearSystemSys(libMesh::LinearImplicitSystem &sys, libMesh::SparseMatrix< libMesh::Number > &system_matrix, NumericVector< libMesh::Number > &rhs, const bool compute_gradients=true)
Assemble both the right hand side and the system matrix of a given linear system. ...
Nonlinear system to be solved.
bool getExodusFileRestart() const
Whether or not we need to use a separate Exodus reader to read the mesh BEFORE we create the mesh...
virtual void swapBackMaterialsFace(const THREAD_ID tid)
virtual void addDistribution(const std::string &type, const std::string &name, InputParameters ¶meters)
The following functions will enable MOOSE to have the capability to import distributions.
virtual void advanceState()
Advance all of the state holding vectors / datastructures so that we can move to the next timestep...
A user object that runs over all the nodes and does an aggregation step to compute a single value...
ExecuteMooseObjectWarehouse< Transfer > _transfers
Normal Transfers.
virtual void customSetup(const ExecFlagType &exec_type)
virtual void checkBoundaryMatProps()
Checks boundary material properties integrity.
std::map< std::string, std::vector< dof_id_type > > _var_dof_map
Based class for output objects.
const VectorPostprocessorValue & getVectorPostprocessorValueByName(const std::string &object_name, const std::string &vector_name, std::size_t t_index=0) const
Get a read-only reference to the vector value associated with the VectorPostprocessor.
virtual void addPredictor(const std::string &type, const std::string &name, InputParameters ¶meters)
virtual Function & getFunction(const std::string &name, const THREAD_ID tid=0)
virtual void computeJacobianBlocks(std::vector< JacobianBlock *> &blocks, const unsigned int nl_sys_num)
Computes several Jacobian blocks simultaneously, summing their contributions into smaller preconditio...
virtual void copySolutionsBackwards()
const ConstBndNodeRange & getCurrentAlgebraicBndNodeRange()
bool _calculate_jacobian_in_uo
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
virtual void reinitElemFaceRef(const Elem *elem, unsigned int side, Real tolerance, const std::vector< Point > *const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0) override
reinitialize FE objects on a given element on a given side at a given set of reference points and the...
virtual void setActiveScalarVariableCoupleableVectorTags(std::set< TagID > &vtags, const THREAD_ID tid)
virtual void prepareFaceShapes(unsigned int var, const THREAD_ID tid) override
virtual void addPostprocessor(const std::string &pp_name, const std::string &name, InputParameters ¶meters)
virtual Real finalNonlinearResidual(const unsigned int nl_sys_num) const override
void addItem(const T &value)
Add an independent item to the set.
std::vector< std::shared_ptr< NonlinearSystemBase > > _nl
The nonlinear systems.
bool automaticScaling() const
Automatic scaling getter.
virtual void computeUserObjects(const ExecFlagType &type, const Moose::AuxGroup &group)
Call compute methods on UserObjects.
virtual void setActiveElementalMooseVariables(const std::set< MooseVariableFEBase *> &moose_vars, const THREAD_ID tid) override
Set the MOOSE variables to be reinited on each element.
virtual void reinit_systems()
std::map< std::pair< BoundaryID, BoundaryID >, NearestNodeLocator * > _nearest_node_locators
std::vector< VariablePhiGradient > _grad_phi_zero
void initialSetup(THREAD_ID tid)
Initial setup.
bool hasJacobian() const
Returns _has_jacobian.
void notifyWhenMeshDisplaces(MeshDisplacedInterface *mdi)
Register an object that derives from MeshDisplacedInterface to be notified when the displaced mesh ge...
void createTagSolutions()
Create extra tagged solution vectors.
std::vector< SolverSystemName > _solver_sys_names
The union of nonlinear and linear system names.
virtual void execute(const ExecFlagType &exec_type)
Convenience function for performing execution of MOOSE systems.
bool _verbose_restore
Whether or not to be verbose on solution restoration post a failed time step.
bool _previous_nl_solution_required
Indicates we need to save the previous NL iteration variable values.
processor_id_type n_processors() const
bool _trust_user_coupling_matrix
Whether to trust the user coupling matrix no matter what.
void setRestartRecoverFileBase(const std::string &file_base)
mutator for recover_base (set by RecoverBaseAction)
unsigned int number() const
const ConvergenceName & getSteadyStateConvergenceName() const
Gets the steady-state detection convergence object name.
void computeResidualAndJacobianTags(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
Form possibly multiple tag-associated vectors and matrices.
void handleException(const std::string &calling_method)
Handle exceptions.
virtual std::vector< VariableName > getVariableNames()
Returns a list of all the variables in the problem (both from the NL and Aux systems.
ReporterData _reporter_data
void uniformRefine()
uniformly refine the problem mesh(es).
virtual void computeResidualSys(libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual)
This function is called by Libmesh to form a residual.
const ReporterData & getReporterData() const
Provides const access the ReporterData object.
virtual const libMesh::CouplingMatrix & nonlocalCouplingMatrix(const unsigned i) const override
std::unique_ptr< libMesh::ConstElemRange > _current_algebraic_elem_range
FunctorMaterials compute functor material properties.
const std::string _type
The type of this class.
std::vector< std::shared_ptr< Transfer > > getTransfers(ExecFlagType type, Transfer::DIRECTION direction) const
Get Transfers by ExecFlagType and direction.
virtual void addConvergence(const std::string &type, const std::string &name, InputParameters ¶meters)
Adds a Convergence object.
MultiPointMap & getPoints()
Returns a writeable reference to the _points container.
bool shouldPrintExecution(const THREAD_ID tid) const
Check whether the problem should output execution orders at this time.
const std::vector< std::shared_ptr< T > > & getActiveObjects(THREAD_ID tid=0) const
Retrieve complete vector to the active all/block/boundary restricted objects for a given thread...
const std::set< subdomain_id_type > & active_subdomains() const
bool havePRefinement() const
Query whether p-refinement has been requested at any point during the simulation. ...
virtual Real l2_norm() const=0
bool getRecomputeMarkersFlag() const
Pull out the _recompute_markers_during_cycles flag previously set through the AdaptivityAction.
const bool & _solve
Whether or not to actually solve the nonlinear system.
virtual const SystemBase & systemBaseSolver(const unsigned int sys_num) const override
Return the solver system object as a base class reference given the system number.
DenseVector< Real > getAllRealReporterValues() const
Get all real reporter values including postprocessor and vector postprocessor values into a dense vec...
ExecuteMooseObjectWarehouse< Transfer > _to_multi_app_transfers
Transfers executed just before MultiApps to transfer data to them.
std::set< SubdomainID > getActiveBlocks(THREAD_ID tid=0) const
Return a set of active SubdomainsIDs.
NonlinearSystemBase * _current_nl_sys
The current nonlinear system that we are solving.
MooseObjectWarehouse< Convergence > _convergences
convergence warehouse
Interface for notifications that the mesh has changed.
virtual std::unique_ptr< Base > create()=0
void createMortarInterface(const std::pair< BoundaryID, BoundaryID > &boundary_key, const std::pair< SubdomainID, SubdomainID > &subdomain_key, SubProblem &subproblem, bool on_displaced, bool periodic, const bool debug, const bool correct_edge_dropping, const Real minimum_projection_angle)
Create mortar generation object.
void setCurrentNonlinearSystem(const unsigned int nl_sys_num)
std::shared_ptr< T > getActiveObject(const std::string &name, THREAD_ID tid=0) const
const std::vector< std::shared_ptr< T > > & getObjects(THREAD_ID tid=0) const
Retrieve complete vector to the all/block/boundary restricted objects for a given thread...
virtual const NumericVector< Number > *const & currentSolution() const override final
The solution vector that is currently being operated on.
void initialSetup()
Initial setup.
Real value(unsigned n, unsigned alpha, unsigned beta, Real x)
Base class for convergence criteria.
MeshBase & getMesh()
Accessor for the underlying libMesh Mesh object.
void min(const T &r, T &o, Request &req) const
virtual void reinitElem(const Elem *elem, const THREAD_ID tid) override
bool needSubdomainMaterialOnSide(SubdomainID subdomain_id, const THREAD_ID tid)
const T & getReporterValue(const ReporterName &reporter_name, const MooseObject &consumer, const ReporterMode &mode, const std::size_t time_index=0) const
Method for returning read only references to Reporter values.
virtual Convergence & getConvergence(const std::string &name, const THREAD_ID tid=0) const
Gets a Convergence object.
TheWarehouse & theWarehouse() const
void createTagVectors()
Create extra tagged vectors and matrices.
virtual void createQRules(libMesh::QuadratureType type, libMesh::Order order, libMesh::Order volume_order=libMesh::INVALID_ORDER, libMesh::Order face_order=libMesh::INVALID_ORDER, SubdomainID block=Moose::ANY_BLOCK_ID, bool allow_negative_qweights=true)
void reinitMaterialsNeighbor(SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true, const std::deque< MaterialBase *> *reinit_mats=nullptr)
reinit materials on the neighboring element face
void setMultiAppFixedPointConvergenceName(const ConvergenceName &convergence_name)
Sets the MultiApp fixed point convergence object name if there is one.
Moose::CouplingType _coupling
Type of variable coupling.
Every object that can be built by the factory should be derived from this class.
void parallelBarrierNotify(const libMesh::Parallel::Communicator &comm, bool messaging=true)
This function implements a parallel barrier function but writes progress to stdout.
virtual bool shouldUpdateSolution()
Check to see whether the problem should update the solution.
virtual void setActiveFEVariableCoupleableVectorTags(std::set< TagID > &vtags, const THREAD_ID tid)
void extraSendList(std::vector< dof_id_type > &send_list, void *context)
///< Type of coordinate system
void addObjects(std::shared_ptr< MaterialBase > block, std::shared_ptr< MaterialBase > neighbor, std::shared_ptr< MaterialBase > face, THREAD_ID tid=0)
A special method unique to this class for adding Block, Neighbor, and Face material objects...
const ConvergenceName & getMultiAppFixedPointConvergenceName() const
Gets the MultiApp fixed point convergence object name.
std::vector< std::string > getAllRealReporterFullNames() const
Get full names of all real reporter values Note: For a postprocessor, the full name is the postproces...
virtual void clearActiveScalarVariableCoupleableVectorTags(const THREAD_ID tid)
Real getTimeFromStateArg(const Moose::StateArg &state) const
Returns the time associated with the requested state.
virtual std::string solverTypeString(unsigned int solver_sys_num=0)
Return solver type as a human readable string.
const ExecFlagType EXEC_TIMESTEP_BEGIN
std::shared_ptr< T > getObject(const std::string &name, THREAD_ID tid=0) const
void executeSamplers(const ExecFlagType &exec_type)
Performs setup and execute calls for Sampler objects.
unsigned int which_neighbor_am_i(const Elem *e) const
virtual void computeJacobianInternal(const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, const std::set< TagID > &tags)
Form a Jacobian matrix for multiple tags.
bool _safe_access_tagged_vectors
Is it safe to retrieve data from tagged vectors.
virtual void computeJacobian(const NumericVector< libMesh::Number > &soln, libMesh::SparseMatrix< libMesh::Number > &jacobian, const unsigned int nl_sys_num)
Form a Jacobian matrix with the default tag (system).
std::optional< std::string > queryStatefulPropName(const unsigned int id) const
void addOutput(const std::string &, const std::string &, InputParameters &)
Adds an Output object.
SolutionIterationType iteration_type
The solution iteration type, e.g. time or nonlinear.
boundary_id_type BoundaryID
void boundaryIntegrityCheckError(const MooseObject &object, const std::set< MooseVariableFieldBase *> &variables, const BoundaryName &boundary_name)
Compose boundary restricted error message for the provided object, variables, and boundary_name if th...
const bool _allow_ics_during_restart
bool constJacobian() const
Returns _const_jacobian (whether a MOOSE object has specified that the Jacobian is the same as the pr...
virtual void clearActiveFEVariableCoupleableMatrixTags(const THREAD_ID tid) override
void computeJacobianTags(const std::set< TagID > &tags)
Computes multiple (tag associated) Jacobian matricese.
SolutionInvalidity & solutionInvalidity()
Get the SolutionInvalidity for this app.
std::vector< MeshChangedInterface * > _notify_when_mesh_changes
Objects to be notified when the mesh changes.
virtual void timestepSetup(THREAD_ID tid=0) const
void checkNonlocalCoupling()
VarKindType
Framework-wide stuff.
void addDefaultSteadyStateConvergence(const InputParameters ¶ms)
Adds the default steady-state detection Convergence.
NonlinearSystemBase & currentNonlinearSystem()
SimpleRange< IndexType > as_range(const std::pair< IndexType, IndexType > &p)
Jacobian-Free Newton Krylov.
void groupUserObjects(TheWarehouse &w, AuxiliarySystem &aux, const ExecFlagEnum &execute_flags, const std::vector< T *> &objs, const std::set< std::string > &ic_deps)
void checkDisplacementOrders()
Verify that SECOND order mesh uses SECOND order displacements.
virtual void addFunction(const std::string &type, const std::string &name, InputParameters ¶meters)
Real PostprocessorValue
various MOOSE typedefs
void uniformly_coarsen(unsigned int n=1)
virtual void addJacobianNeighbor(const THREAD_ID tid) override
virtual TagID addMatrixTag(TagName tag_name)
Create a Tag.
virtual libMesh::EquationSystems & es() override
std::vector< std::unordered_map< SubdomainID, bool > > _block_mat_side_cache
Cache for calculating materials on side.
std::shared_ptr< AuxiliarySystem > _aux
The auxiliary system.
void setRestart(bool value)
Sets the restart/recover flags.
AttribBoundaries tracks all boundary IDs associated with an object.
void setValue(unsigned int i, Number value)
Set the nodal value for this variable (to keep everything up to date.
virtual void reinitElemFaceRef(const Elem *elem, unsigned int side, Real tolerance, const std::vector< Point > *const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0)
reinitialize FE objects on a given element on a given side at a given set of reference points and the...
virtual void addVectorPostprocessor(const std::string &pp_name, const std::string &name, InputParameters ¶meters)
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
virtual bool converged(const unsigned int sys_num)
Eventually we want to convert this virtual over to taking a solver system number argument.
virtual unsigned int currentNlSysNum() const override
virtual void computeIndicators()
virtual MooseVariableScalar & getScalarVariable(const THREAD_ID tid, const std::string &var_name) override
Returns the scalar variable reference from whichever system contains it.
const bool _boundary_restricted_node_integrity_check
whether to perform checking of boundary restricted nodal object variable dependencies, e.g.
virtual void setActiveScalarVariableCoupleableVectorTags(std::set< TagID > &vtags, const THREAD_ID tid) override
virtual void updateActive(THREAD_ID tid=0)
Update the active status of Kernels.
virtual bool updateMeshXFEM()
Update the mesh due to changing XFEM cuts.
virtual const SystemBase & systemBaseNonlinear(const unsigned int sys_num) const override
Return the nonlinear system object as a base class reference given the system number.
std::vector< MortarUserObject * > getMortarUserObjects(BoundaryID primary_boundary_id, BoundaryID secondary_boundary_id, bool displaced, const std::vector< MortarUserObject *> &mortar_uo_superset)
Helper for getting mortar objects corresponding to primary boundary ID, secondary boundary ID...
virtual void restoreSolutions()
virtual bool hasConvergence(const std::string &name, const THREAD_ID tid=0) const
Returns true if the problem has a Convergence object of the given name.
void markFamilyPRefinement(const InputParameters ¶ms)
Mark a variable family for either disabling or enabling p-refinement with valid parameters of a varia...
virtual const std::vector< dof_id_type > & dofIndices() const
Get local DoF indices.
void addAnyRedistributers()
const std::string & type() const
Get the type of this class.
bool hasPostprocessorValueByName(const PostprocessorName &name) const
Whether or not a Postprocessor value exists by a given name.
virtual void checkBlockMatProps()
Checks block material properties integrity.
void restoreFromInitialBackup(const bool for_restart)
Restores from a "initial" backup, that is, one set in _initial_backup.
void setAxisymmetricCoordAxis(const MooseEnum &rz_coord_axis)
void initialSetup() override
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
void reinit()
Completely redo all geometric search objects.
std::vector< VectorTag > getVectorTags(const std::set< TagID > &tag_ids) const
bool allowInvalidSolution() const
Whether to accept / allow an invalid solution.
virtual const SystemBase & systemBaseAuxiliary() const override
Return the auxiliary system object as a base class reference.
void setLinearConvergenceNames(const std::vector< ConvergenceName > &convergence_names)
Sets the linear convergence object name(s) if there is one.
void checkUserObjectJacobianRequirement(THREAD_ID tid)
MooseVariableFieldBase & getActualFieldVariable(const THREAD_ID tid, const std::string &var_name) override
Returns the variable reference for requested MooseVariableField which may be in any system...
void finalize(const std::string &object_name)
Helper function for performing post calculation actions via the ReporterContext objects.
void addObject(std::shared_ptr< InitialConditionBase > object, THREAD_ID tid, bool recurse=true)
Add object to the warehouse.
virtual void disassociateVectorFromTag(NumericVector< Number > &vec, TagID tag)
Disassociate a given vector from a given tag.
virtual void computeNullSpace(libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > *> &sp)
virtual void addTimeIntegrator(const std::string &type, const std::string &name, InputParameters ¶meters)
LinearSystem * _current_linear_sys
The current linear system that we are solving.
virtual void cacheResidual(const THREAD_ID tid) override
virtual void computeResidualType(const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, TagID tag)
Form a residual vector for a given tag and "residual" tag.
const bool _force_restart
void checkCoordinateSystems()
Performs a sanity check for every element in the mesh.
QueryCache clone() const
clone creates and returns an independent copy of the query in its current state.
const std::set< SubdomainID > & getMortarSubdomainIDs() const
Returns the mortar covered subdomains.
void forceOutput()
Indicates that the next call to outputStep should be forced.
const VectorPostprocessor & getVectorPostprocessorObjectByName(const std::string &object_name, const THREAD_ID tid=0) const
Return the VPP object given the name.
std::vector< VariablePhiSecond > _second_phi_zero
StoredRange< std::vector< GeneralUserObject * >::iterator, GeneralUserObject * > GeneralUserObjectRange
bool _started_initial_setup
At or beyond initialSteup stage.
std::map< std::string, std::unique_ptr< RandomData > > _random_data_objects
A map of objects that consume random numbers.
virtual bool vectorTagExists(const TagID tag_id) const
Check to see if a particular Tag exists.
std::unique_ptr< ConstBndNodeRange > _current_algebraic_bnd_node_range
virtual void addResidual(const THREAD_ID tid) override
virtual void addResidualNeighbor(const THREAD_ID tid) override
virtual void reinitNeighborFaceRef(const Elem *neighbor_elem, unsigned int neighbor_side, Real tolerance, const std::vector< Point > *const pts, const std::vector< Real > *const weights=nullptr, const THREAD_ID tid=0) override
reinitialize FE objects on a given neighbor element on a given side at a given set of reference point...
void setCoordSystem(const std::vector< SubdomainName > &blocks, const MultiMooseEnum &coord_sys)
Set the coordinate system for the provided blocks to coord_sys.
Base class for all Postprocessors.
libMesh::ExodusII_IO * getExReaderForRestart() const
Get the Exodus reader to restart variables from an Exodus mesh file.
void needSolutionState(unsigned int oldest_needed, Moose::SolutionIterationType iteration_type)
Declare that we need up to old (1) or older (2) solution states for a given type of iteration...
void clearPoints()
Remove all of the current points and elements.
std::string typeAndName() const
Get the class's combined type and name; useful in error handling.
MooseApp & _app
The MOOSE application this is associated with.
void paramError(const std::string ¶m, Args... args) const
Emits an error prefixed with the file and line number of the given param (from the input file) along ...
virtual void clearActiveFEVariableCoupleableVectorTags(const THREAD_ID tid) override
void maxloc(T &r, unsigned int &max_id) const
bool isValueSet(const std::string &value) const
Methods for seeing if a value is set in the MultiMooseEnum.
void setCouplingMatrix(std::unique_ptr< libMesh::CouplingMatrix > cm, const unsigned int nl_sys_num)
Set custom coupling matrix.
unsigned int number() const
Gets the number of this system.
virtual void addDefaultNonlinearConvergence(const InputParameters ¶ms)
Adds the default nonlinear Convergence associated with the problem.
virtual void solve() override
Solve the system (using libMesh magic)
void setNonlinearConvergenceNames(const std::vector< ConvergenceName > &convergence_names)
Sets the nonlinear convergence object name(s) if there is one.
unsigned int uniformRefineLevel() const
Returns the level of uniform refinement requested (zero if AMR is disabled).
const ExecFlagType EXEC_LINEAR
TODO: delete this later - it is a temporary hack for dealing with inter-system dependencies.
virtual bool solverSystemConverged(const unsigned int solver_sys_num) override
std::string stringify(const T &t)
conversion to string
std::string _exception_message
The error message to go with an exception.
const std::set< SubdomainID > & boundaryLowerDBlocks() const
std::vector< SubdomainName > getSubdomainNames(const std::vector< SubdomainID > &subdomain_ids) const
Get the associated subdomainNames for the subdomain ids that are passed in.
virtual void checkProblemIntegrity()
Method called to perform a series of sanity checks before a simulation is run.
void setReporterValue(const ReporterName &reporter_name, const T &value, const std::size_t time_index=0)
Method for setting Reporter values that already exist.
Class for storing and utilizing output objects.
AuxiliarySystem & getAuxiliarySystem()
virtual void initialSetup(THREAD_ID tid=0) const
Convenience methods for calling object setup methods.
virtual void updateGeomSearch(GeometricSearchData::GeometricSearchType type=GeometricSearchData::ALL) override
void petscSetOptions(const PetscOptions &po, const SolverParams &solver_params, FEProblemBase *const problem=nullptr)
A function for setting the PETSc options in PETSc from the options supplied to MOOSE.
MooseObjectWarehouse< MeshDivision > _mesh_divisions
Warehouse to store mesh divisions NOTE: this could probably be moved to the MooseMesh instead of the ...
virtual void addConstraint(const std::string &c_name, const std::string &name, InputParameters ¶meters)
void buildRefinementAndCoarseningMaps(Assembly *assembly)
Create the refinement and coarsening maps necessary for projection of stateful material properties wh...
MooseObjectWarehouse< Indicator > _indicators
virtual void addMultiApp(const std::string &multi_app_name, const std::string &name, InputParameters ¶meters)
Add a MultiApp to the problem.
virtual void prepareAssembly(const THREAD_ID tid) override
bool haveADObjects() const
Method for reading wehther we have any ad objects.
unsigned int systemNumForVariable(const VariableName &variable_name) const
bool _checking_uo_aux_state
Flag used to indicate whether we are doing the uo/aux state check in execute.
const PostprocessorValue & getPostprocessorValueByName(const PostprocessorName &name, std::size_t t_index=0) const
Get a read-only reference to the value associated with a Postprocessor that exists.
MeshBase::element_iterator activeLocalElementsBegin()
Calls active_local_nodes_begin/end() on the underlying libMesh mesh object.
InitialConditions are objects that set the initial value of variables.
Base class for user objects executed on all element sides internal to one or more blocks...
virtual void clearActiveScalarVariableCoupleableMatrixTags(const THREAD_ID tid)
virtual std::map< TagName, TagID > & getMatrixTags()
Return all matrix tags in the system, where a tag is represented by a map from name to ID...
virtual void initNullSpaceVectors(const InputParameters ¶meters, std::vector< std::shared_ptr< NonlinearSystemBase >> &nl)
virtual bool hasVariable(const std::string &var_name) const
Query a system for a variable.
Executioner * getExecutioner() const
Retrieve the Executioner for this App.
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override
void broadcast(T &data, const unsigned int root_id=0, const bool identical_sizes=false) const
virtual void clearDiracInfo() override
Gets called before Dirac Kernels are asked to add the points they are supposed to be evaluated in...
virtual void addIndicator(const std::string &indicator_name, const std::string &name, InputParameters ¶meters)
virtual void reinitNodesNeighbor(const std::vector< dof_id_type > &nodes, const THREAD_ID tid) override
bool duplicateVariableCheck(const std::string &var_name, const libMesh::FEType &type, bool is_aux, const std::set< SubdomainID > *const active_subdomains)
Helper to check for duplicate variable names across systems or within a single system.
virtual void solve() override=0
Solve the system (using libMesh magic)
GeometricSearchType
Used to select groups of geometric search objects to update.
void backupMultiApps(ExecFlagType type)
Backup the MultiApps associated with the ExecFlagType.
A ReporterName that represents a Postprocessor.
virtual void addVariable(const std::string &var_type, const std::string &var_name, InputParameters ¶ms)
Canonical method for adding a non-linear variable.
bool doingPRefinement() const
ExecuteMooseObjectWarehouse< MultiApp > _multi_apps
MultiApp Warehouse.
virtual void jacobianSetup(THREAD_ID tid=0) const
void updateBoundaryMatPropDependency(std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
void uniformRefineWithProjection()
Performs uniform refinement on the meshes in the current object.
TagID residualVectorTag() const override
std::vector< std::vector< std::unique_ptr< Assembly > > > _assembly
The Assembly objects.
virtual void addDisplacedProblem(std::shared_ptr< DisplacedProblem > displaced_problem)
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const
void computeResidual(libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual)
This function is called by Libmesh to form a residual.
virtual void cacheJacobianNeighbor(const THREAD_ID tid)
void setVectorPostprocessorValueByName(const std::string &object_name, const std::string &vector_name, const VectorPostprocessorValue &value, std::size_t t_index=0)
Set the value of a VectorPostprocessor vector.
virtual MooseVariable & getStandardVariable(const THREAD_ID tid, const std::string &var_name) override
Returns the variable reference for requested MooseVariable which may be in any system.
virtual void initialSetup(THREAD_ID tid=0) const
Convenience methods for calling object setup methods that handle the extra neighbor and face objects...
void setCoordSystem(const std::vector< SubdomainName > &blocks, const MultiMooseEnum &coord_sys)
virtual void swapBackMaterialsNeighbor(const THREAD_ID tid)
virtual void addLinearFVKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
bool hasStatefulProperties() const
void residualSetup()
Calls the residualSetup function for each of the output objects.
virtual NonlinearSystem & getNonlinearSystem(const unsigned int sys_num)
void solveSetup()
Calls the timestepSetup function for each of the output objects.
void sort(THREAD_ID tid=0)
virtual bool reinitDirac(const Elem *elem, const THREAD_ID tid) override
Returns true if the Problem has Dirac kernels it needs to compute on elem.
MooseAppCoordTransform & coordTransform()
virtual void cacheResidual(const THREAD_ID tid)
virtual void timestepSetup()
libMesh::Order order() const
Get the order of this variable Note: Order enum can be implicitly converted to unsigned int...
const ExecFlagType EXEC_PRE_DISPLACE
virtual const Elem * elem_ptr(const dof_id_type i) const=0
const std::vector< NonlinearSystemName > _nl_sys_names
The nonlinear system names.
const ExecFlagType EXEC_POSTCHECK
PetscErrorCode PetscInt const PetscInt fields[]
const ExecFlagType EXEC_NONLINEAR
std::vector< Real > VectorPostprocessorValue
virtual void updateMortarMesh()
void copyValuesBack()
At the end of a timestep this method is called to copy the values back in time in preparation for the...
void update()
Builds mortar segment meshes for each mortar interface.
const std::vector< const Elem * > & coarsenedElementChildren(const Elem *elem) const
Get the newly removed children element ids for an element that was just coarsened.
void restore(const std::filesystem::path &folder_base, const bool for_restart)
Restore an application from file.
void addDefaultMultiAppFixedPointConvergence(const InputParameters ¶ms)
Adds the default fixed point Convergence associated with the problem.
std::set< TagID > _fe_matrix_tags
virtual NumericVector< Number > & RHS()=0
virtual void addAuxArrayVariable(const std::string &var_name, const libMesh::FEType &type, unsigned int components, const std::set< SubdomainID > *const active_subdomains=NULL)
const ExecuteMooseObjectWarehouse< Transfer > & getMultiAppTransferWarehouse(Transfer::DIRECTION direction) const
Return the complete warehouse for MultiAppTransfer object for the given direction.
virtual const SystemBase & getSystemBase(const unsigned int sys_num) const
Get constant reference to a system in this problem.
const Elem * neighbor_ptr(unsigned int i) const
virtual void reinitLowerDElem(const Elem *lower_d_elem, const THREAD_ID tid, const std::vector< Point > *const pts=nullptr, const std::vector< Real > *const weights=nullptr) override
const T & getParam(const std::string &name)
Retrieve a parameter for the object.
void removeSubstring(std::string &main, const std::string &sub)
find, erase, length algorithm for removing a substring from a string
Provides a way for users to bail out of the current solve.
virtual void addReporter(const std::string &type, const std::string &name, InputParameters ¶meters)
Add a Reporter object to the simulation.
virtual void swapBackMaterials(const THREAD_ID tid)
std::vector< VariablePhiValue > _phi_zero
InitialConditionWarehouse _ics
std::vector< unsigned char > _has_active_material_properties
Whether there are active material properties on each thread.
MaterialWarehouse _discrete_materials
bool _reinit_displaced_face
Whether to call DisplacedProblem::reinitElemFace when this->reinitElemFace is called.
void updateBlockMatPropDependency(SubdomainID id, std::unordered_set< unsigned int > &needed_mat_props, THREAD_ID tid=0) const
void setSinglePetscOption(const std::string &name, const std::string &value="", FEProblemBase *const problem=nullptr)
A wrapper function for dealing with different versions of PetscOptionsSetValue.
virtual void initialSetup()
NumericVector< Number > & getRightHandSideVector()
Fetching the right hand side vector from the libmesh system.
virtual void addDGKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual void setCurrentBoundaryID(BoundaryID bid, const THREAD_ID tid) override
sets the current boundary ID in assembly
SolverSystem * _current_solver_sys
The current solver system.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual std::shared_ptr< const DisplacedProblem > getDisplacedProblem() const
virtual bool contract()=0
std::optional< std::vector< ConvergenceName > > _nonlinear_convergence_names
Nonlinear system(s) convergence name(s)
Generic class for solving transient nonlinear problems.
virtual void preProblemInit()
Perform initializations during executing actions right before init_problem task.
void updateActiveSemiLocalNodeRange(std::set< dof_id_type > &ghosted_elems)
Clears the "semi-local" node list and rebuilds it.
subdomain_id_type subdomain_id() const
virtual void stopSolve(const ExecFlagType &exec_flag, const std::set< TagID > &vector_tags_to_close)=0
Quit the current solve as soon as possible.
const InputParameters * getCommonParameters() const
Get a reference to the common output parameters.
TagID timeVectorTag() const override
Ideally, we should not need this API.
std::map< SubdomainID, std::set< MaterialPropertyName > > _zero_block_material_props
Set of properties returned as zero properties.
Class for containing MooseEnum item information.
unsigned int solverSysNum(const SolverSystemName &solver_sys_name) const override
std::shared_ptr< MaterialBase > getMaterial(std::string name, Moose::MaterialDataType type, const THREAD_ID tid=0, bool no_warn=false)
Return a pointer to a MaterialBase object.
virtual void swap(NumericVector< T > &v)
bool hasActiveObject(const std::string &name, THREAD_ID tid=0) const
Convenience functions for checking/getting specific objects.
std::vector< VariableGradient > _grad_zero
bool hasActiveObjects(THREAD_ID tid=0) const
void clearCurrentJacobianMatrixTags()
Clear the current Jacobian matrix tag data structure ...
CTSub CT_OPERATOR_BINARY CTMul CTCompareLess CTCompareGreater CTCompareEqual _arg template * sqrt(_arg)) *_arg.template D< dtag >()) CT_SIMPLE_UNARY_FUNCTION(tanh
virtual void subdomainSetup(SubdomainID subdomain, const THREAD_ID tid)
virtual void restoreOldSolutions()
Restore old solutions from the backup vectors and deallocate them.
unsigned int getInitialSteps() const
Pull out the number of initial steps previously set by calling init()
void max(const T &r, T &o, Request &req) const
void reinitMaterials(SubdomainID blk_id, const THREAD_ID tid, bool swap_stateful=true)
virtual unsigned short dim() const=0
const AutomaticMortarGeneration & getMortarInterface(const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced) const
Return the undisplaced or displaced mortar generation object associated with the provided boundaries ...
bool acceptInvalidSolution() const
Whether or not to accept the solution based on its invalidity.
void setLoadAllVectors(const bool load_all_vectors)
Sets whether or not all vectors are to be loaded.
Class for threaded computation of UserObjects.
const bool _restore_original_nonzero_pattern
Whether we should restore the original nonzero pattern for every Jacobian evaluation.
void setRandomDataPointer(RandomData *random_data)
Base class for all MultiAppTransfer objects.
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
void execMultiAppTransfers(ExecFlagType type, Transfer::DIRECTION direction)
Execute MultiAppTransfers associated with execution flag and direction.
T & set(const std::string &)
Wrapper class that owns a libMesh EquationSystem and adds advanced restart capability to it...
void restoreMultiApps(ExecFlagType type, bool force=false)
Restore the MultiApps associated with the ExecFlagType.
virtual void addLinearFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters ¶meters)
virtual bool is_vertex(const unsigned int i) const=0
void subdomainSetup()
Calls the subdomainSetup function for each of the output objects.
const std::vector< dof_id_type > & allDofIndices() const
Get all global dofindices for the variable.
const std::vector< std::string > & get_elem_var_names()
void addMaterialPropertyStorage(MaterialPropertyStorage &mat_props)
Pushes the given pair ( mat_data , mat_props ) onto our list of _materials data to redistribute each ...
SparseMatrix< Number > * matrix
void customSetup(const ExecFlagType &exec_type) override
void setRestartFile(const std::string &file_name)
Communicate to the Resurector the name of the restart filer.
void setCurrentLinearSystem(unsigned int sys_num)
Set the current linear system pointer.
void initNonlocalCoupling()
Create pair of variables requiring nonlocal jacobian contributions.
void executeControls(const ExecFlagType &exec_type)
Performs setup and execute calls for Control objects.
virtual std::vector< std::shared_ptr< UserObject > > addUserObject(const std::string &user_object_name, const std::string &name, InputParameters ¶meters)
Query query()
query creates and returns an initialized a query object for querying objects from the warehouse...
void allowOutput(bool state)
Ability to enable/disable output calls This is private, users should utilize FEProblemBase::allowOutp...
bool hasStartTime() const
virtual void onTimestepBegin() override
virtual void computeBounds(libMesh::NonlinearImplicitSystem &sys, NumericVector< libMesh::Number > &lower, NumericVector< libMesh::Number > &upper)
Nonlinear system to be solved.
virtual void computePostCheck(libMesh::NonlinearImplicitSystem &sys, const NumericVector< libMesh::Number > &old_soln, NumericVector< libMesh::Number > &search_direction, NumericVector< libMesh::Number > &new_soln, bool &changed_search_direction, bool &changed_new_soln)
void checkDuplicatePostprocessorVariableNames()
void setAxisymmetricCoordAxis(const MooseEnum &rz_coord_axis)
For axisymmetric simulations, set the symmetry coordinate axis.
void addOutput(std::shared_ptr< Output > output)
Adds an existing output object to the warehouse.
void computeResidualAndJacobian(const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, libMesh::SparseMatrix< libMesh::Number > &jacobian)
Form a residual and Jacobian with default tags.
bool hasDisplacedObjects() const
Returns whether any of the AutomaticMortarGeneration objects are running on a displaced mesh...
std::vector< std::pair< MooseVariableFEBase *, MooseVariableFEBase * > > & nonlocalCouplingEntries(const THREAD_ID tid, const unsigned int nl_sys_num)
static void selectMatrixTagsFromSystem(const SystemBase &system, const std::map< TagName, TagID > &input_matrix_tags, std::set< TagID > &selected_tags)
Select the matrix tags which belong to a specific system.
std::vector< VariableValue > _scalar_zero
virtual Real computeResidualL2Norm()
Computes the residual using whatever is sitting in the current solution vector then returns the L2 no...
void update(GeometricSearchType type=ALL)
Update all of the search objects.
const std::vector< LinearSystemName > _linear_sys_names
The linear system names.
void incrementMultiAppTStep(ExecFlagType type)
Advance the MultiApps t_step (incrementStepOrReject) associated with the ExecFlagType.
Class for scalar variables (they are different).
IntRange< T > make_range(T beg, T end)
void computeLinearSystemTags(const NumericVector< libMesh::Number > &soln, const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags, const bool compute_gradients=true)
Assemble the current linear system given a set of vector and matrix tags.
void bumpVolumeQRuleOrder(libMesh::Order order, SubdomainID block)
Increases the element/volume quadrature order for the specified mesh block if and only if the current...
const bool _material_dependency_check
Determines whether a check to verify material dependencies on every subdomain.
std::vector< std::vector< const MooseVariableFEBase * > > _uo_jacobian_moose_vars
virtual MooseMesh & mesh() override
NonlocalKernel is used for solving integral terms in integro-differential equations.
virtual void subdomainSetup(THREAD_ID tid=0) const
std::vector< VariableValue > _zero
const ExecFlagType EXEC_SAME_AS_MULTIAPP
unsigned int linearSysNum(const LinearSystemName &linear_sys_name) const override
LinearSystem & currentLinearSystem()
Get a non-constant reference to the current linear system.
virtual void updateActive(THREAD_ID tid=0) override
Update the active status of Kernels.
std::set< TagID > _fe_vector_tags
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
void addObjectParamsHelper(InputParameters ¶ms, const std::string &object_name, const std::string &var_param_name="variable")
Helper for setting the "_subproblem" and "_sys" parameters in addObject() and in addUserObject().
virtual unsigned int size() const override final
SolverParams & solverParams(unsigned int solver_sys_num=0)
Get the solver parameters.
virtual void saveOldSolutions()
Allocate vectors and save old solutions into them.
std::unique_ptr< NumericVector< Number > > current_local_solution
ADRealVectorValue ADRealGradient
virtual void setActiveFEVariableCoupleableMatrixTags(std::set< TagID > &mtags, const THREAD_ID tid)
void mooseConsole()
Send current output buffer to Console output objects.
std::set< std::string > getDependObjects() const
Get a list of dependent UserObjects for this exec type.
virtual void computeTransposeNullSpace(libMesh::NonlinearImplicitSystem &sys, std::vector< NumericVector< libMesh::Number > *> &sp)
bool hasPostprocessor(const std::string &name) const
Deprecated.
virtual bool updateSolution(NumericVector< libMesh::Number > &vec_solution, NumericVector< libMesh::Number > &ghosted_solution)
Update the solution.
ChainControlDataSystem & getChainControlDataSystem()
Gets the system that manages the ChainControls.
std::shared_ptr< DisplacedProblem > _displaced_problem
GeometricSearchData _geometric_search_data
const InputParameters & parameters() const
Get the parameters of the object.
State argument for evaluating functors.
void setCurrentResidualVectorTags(const std::set< TagID > &vector_tags)
Set the current residual vector tag data structure based on the passed in tag IDs.
MooseObjectWarehouse< Function > _functions
functions
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true)
Adds an object to the storage structure.
virtual Real & timeOld() const
Proxy for accessing MaterialPropertyStorage.
std::vector< VectorVariableValue > _vector_zero
bool hasMultiApp(const std::string &name) const
void createMortarInterface(const std::pair< BoundaryID, BoundaryID > &primary_secondary_boundary_pair, const std::pair< SubdomainID, SubdomainID > &primary_secondary_subdomain_pair, bool on_displaced, bool periodic, const bool debug, const bool correct_edge_dropping, const Real minimum_projection_angle)
std::vector< std::unique_ptr< libMesh::CouplingMatrix > > _cm
Coupling matrix for variables.
bool needInterfaceMaterialOnSide(BoundaryID bnd_id, const THREAD_ID tid)
void reinitElemFace(const Elem *elem, unsigned int side, BoundaryID, const THREAD_ID tid)
virtual void cacheResidualNeighbor(const THREAD_ID tid)
Linear system to be solved.
bool hasReporterValue(const ReporterName &reporter_name) const
Return True if a Reporter value with the given type and name have been created.
std::optional< std::vector< ConvergenceName > > _linear_convergence_names
Linear system(s) convergence name(s) (if any)
bool _has_initialized_stateful
Whether nor not stateful materials have been initialized.
void checkICRestartError(const std::string &ic_name, const std::string &name, const VariableName &var_name)
Checks if the variable of the initial condition is getting restarted and errors for specific cases...
virtual void setResidualNeighbor(NumericVector< libMesh::Number > &residual, const THREAD_ID tid) override
QueryCache & condition(Args &&... args)
Adds a new condition to the query.
const TagName SOLUTION_TAG
unsigned int _max_qps
Maximum number of quadrature points used in the problem.
A class for storing an input parameter name.
static InputParameters validParams()
Eigen::Matrix< Real, Eigen::Dynamic, 1 > RealEigenVector
virtual void addScalarKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
elem_info_iterator ownedElemInfoEnd()
std::set< const Elem * > & getElements()
Returns a writeable reference to the _elements container.
virtual void set(const numeric_index_type i, const T value)=0
void addGhostedBoundary(BoundaryID boundary_id)
This will add the boundary ids to be ghosted to this processor.
bool _preserve_matrix_sparsity_pattern
Whether to preserve the system matrix / Jacobian sparsity pattern, using 0-valued entries usually...
virtual unsigned int nNonlinearIterations(const unsigned int nl_sys_num) const override
CoverageCheckMode _material_coverage_check
Determines whether and which subdomains are to be checked to ensure that they have an active material...
bool isAdaptivityDue()
Query if an adaptivity step should be performed at the current time / time step.
virtual std::size_t numLinearSystems() const override
MaterialPropertyStorage & _neighbor_material_props
std::unique_ptr< Backup > finalizeRestore()
Finalizes (closes) the restoration process done in restore().
libMesh::StoredRange< MooseMesh::const_bnd_elem_iterator, const BndElement * > * getBoundaryElementRange()
MOOSE now contains C++17 code, so give a reasonable error message stating what the user can do to add...
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
const std::size_t _num_linear_sys
The number of linear systems.
std::map< std::string, unsigned int > _subspace_dim
Dimension of the subspace spanned by the vectors with a given prefix.
const libMesh::ConstElemRange & getEvaluableElementRange()
In general, {evaluable elements} >= {local elements} U {algebraic ghosting elements}.
void paramWarning(const std::string ¶m, Args... args) const
Emits a warning prefixed with the file and line number of the given param (from the input file) along...
static InputParameters validParams()
bool _currently_computing_residual
Whether the residual is being evaluated.
const UserObject & getUserObjectBase(const std::string &name, const THREAD_ID tid=0) const
Get the user object by its name.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type...
MooseVariableFieldBase & getVariable(THREAD_ID tid, const std::string &var_name) const
Gets a reference to a variable of with specified name.
bool _has_internal_edge_residual_objects
Whether the problem has dgkernels or interface kernels.
bool execMultiApps(ExecFlagType type, bool auto_advance=true)
Execute the MultiApps associated with the ExecFlagType.
const std::string & name() const
const std::unordered_map< std::pair< BoundaryID, BoundaryID >, AutomaticMortarGeneration > & getMortarInterfaces(bool on_displaced) const
virtual ArrayMooseVariable & getArrayVariable(const THREAD_ID tid, const std::string &var_name) override
Returns the variable reference for requested ArrayMooseVariable which may be in any system...
const ExecFlagType EXEC_SUBDOMAIN
bool _has_constraints
Whether or not this system has any Constraints.
virtual bool isTransient() const override
bool hasMultiApps() const
Returns whether or not the current simulation has any multiapps.
virtual void reinitNeighbor(const Elem *elem, unsigned int side, const THREAD_ID tid) override
const MaterialData & getMaterialData(const THREAD_ID tid) const
void doingPRefinement(bool doing_p_refinement)
Indicate whether the kind of adaptivity we're doing is p-refinement.
const bool & currentlyComputingJacobian() const
Returns true if the problem is in the process of computing the Jacobian.
void notifyWhenMeshChanges(MeshChangedInterface *mci)
Register an object that derives from MeshChangedInterface to be notified when the mesh changes...
ConstElemPointerRange * coarsenedElementRange() const
Return a range that is suitable for threaded execution over elements that were just coarsened...
std::unique_ptr< libMesh::ConstElemRange > _evaluable_local_elem_range
const Moose::PatchUpdateType & getPatchUpdateStrategy() const
Get the current patch update strategy.
virtual void executeAllObjects(const ExecFlagType &exec_type)
CoverageCheckMode _kernel_coverage_check
Determines whether and which subdomains are to be checked to ensure that they have an active kernel...
virtual void setActiveFEVariableCoupleableVectorTags(std::set< TagID > &vtags, const THREAD_ID tid) override
void check() const
Perform integrity check for get/declare calls.
std::set< std::string > getPostprocessorNames() const
Return a list of all postprocessor names.
bool _fail_next_system_convergence_check
void ghostGhostedBoundaries()
Actually do the ghosting of boundaries that need to be ghosted to this processor. ...
std::vector< std::shared_ptr< LinearSystem > > _linear_systems
The vector of linear systems.
std::shared_ptr< XFEMInterface > _xfem
Pointer to XFEM controller.
virtual void prepareShapes(unsigned int var, const THREAD_ID tid) override
const bool _boundary_restricted_elem_integrity_check
whether to perform checking of boundary restricted elemental object variable dependencies, e.g.
void reinitMaterialsInterface(BoundaryID boundary_id, const THREAD_ID tid, bool swap_stateful=true)
bool _const_jacobian
true if the Jacobian is constant
virtual void computeJacobianBlock(libMesh::SparseMatrix< libMesh::Number > &jacobian, libMesh::System &precond_system, unsigned int ivar, unsigned int jvar)
Really not a good idea to use this.
virtual void solveLinearSystem(const unsigned int linear_sys_num, const Moose::PetscSupport::PetscOptions *po=nullptr)
Build and solve a linear system.
virtual void computeUserObjectByName(const ExecFlagType &type, const Moose::AuxGroup &group, const std::string &name)
Compute an user object with the given name.
virtual void possiblyRebuildGeomSearchPatches()
virtual void add(const numeric_index_type i, const T value)=0
bool _safe_access_tagged_matrices
Is it safe to retrieve data from tagged matrices.
std::set< TagID > _linear_vector_tags
Temporary storage for filtered vector tags for linear systems.
Class that represents the dependecy as a graph.
DiracKernelInfo _dirac_kernel_info
A MultiApp represents one or more MOOSE applications that are running simultaneously.
const TagName PREVIOUS_NL_SOLUTION_TAG
void updateBoundaryVariableDependency(std::set< MooseVariableFieldBase *> &needed_moose_vars, THREAD_ID tid=0) const
processor_id_type processor_id() const
void addObject(std::shared_ptr< FVInitialConditionBase > object, THREAD_ID tid, bool recurse=true)
Add object to the warehouse.
std::vector< T * > & queryIntoUnsorted(std::vector< T *> &results, Args &&... args)
queryInto executes the query and stores the results in the given vector.
const libMesh::ConstElemRange & getNonlinearEvaluableElementRange()
A class for storing the names of MooseObject by tag and object name.
MaterialPropertyStorage & _material_props
Base class for Postprocessors that produce a vector of values.
virtual Order default_order() const=0
void prepareMaterials(const std::unordered_set< unsigned int > &consumer_needed_mat_props, const SubdomainID blk_id, const THREAD_ID tid)
Add the MooseVariables and the material properties that the current materials depend on to the depend...
virtual void addFVKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual void addFVBC(const std::string &fv_bc_name, const std::string &name, InputParameters ¶meters)
libMesh::Order _max_scalar_order
Maximum scalar variable order.
virtual void addGhostedBoundary(BoundaryID boundary_id) override
Will make sure that all necessary elements from boundary_id are ghosted to this processor.
virtual bool hasFunction(const std::string &name, const THREAD_ID tid=0)
Adaptivity & adaptivity()
bool hasActiveMaterialProperties(const THREAD_ID tid) const
Method to check whether or not a list of active material roperties has been set.
ExecuteMooseObjectWarehouse< Transfer > _between_multi_app_transfers
Transfers executed just before MultiApps to transfer data between them.
bool isRecovering() const
Whether or not this is a "recover" calculation.
SystemBase & sys()
Get the system this variable is part of.
virtual void cacheJacobian(const THREAD_ID tid) override
auto min(const L &left, const R &right)
void jacobianSetup() override
virtual std::size_t numSolverSystems() const override
virtual void addHDGKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
Restartable::ManagedValue< RestartableEquationSystems > _req
The EquationSystems object, wrapped for restart.
virtual unsigned int currentLinearSysNum() const override
std::vector< libMesh::CouplingMatrix > _nonlocal_cm
nonlocal coupling matrix
virtual void reinitNodeFace(const Node *node, BoundaryID bnd_id, const THREAD_ID tid) override
virtual void reinitOffDiagScalars(const THREAD_ID tid) override
processor_id_type processor_id() const
virtual void reinitElemPhys(const Elem *elem, const std::vector< Point > &phys_points_in_elem, const THREAD_ID tid) override
std::vector< std::unordered_map< BoundaryID, bool > > _interface_mat_side_cache
Cache for calculating materials on interface.
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.
const std::vector< std::string > & get_nodal_var_names()
std::string getRestartRecoverFileBase() const
The file_base for the recovery file.
virtual void addJacobianNeighborLowerD(const THREAD_ID tid) override
virtual void prepareNeighborShapes(unsigned int var, const THREAD_ID tid) override
MooseObjectWarehouse< Marker > _markers
FVInitialConditionWarehouse _fv_ics
void setVerboseProblem(bool verbose)
Make the problem be verbose.
virtual void setNeighborSubdomainID(const Elem *elem, unsigned int side, const THREAD_ID tid) override
virtual const VectorTag & getVectorTag(const TagID tag_id) const
Get a VectorTag from a TagID.
MaterialBases compute MaterialProperties.
virtual void initialAdaptMesh()
void updatePointLocator(const MooseMesh &mesh)
Called during FEProblemBase::meshChanged() to update the PointLocator object used by the DiracKernels...
virtual void addResidualScalar(const THREAD_ID tid=0)
This is a template class that implements the workhorse compute and computeNodal methods.
MaterialWarehouse _all_materials
const MeshBase::element_iterator activeLocalElementsEnd()
virtual void addCachedResidual(const THREAD_ID tid) override
for(PetscInt i=0;i< nvars;++i)
void clearNearestNodeLocators()
Clear out the Penetration Locators so they will redo the search.
Moose::PetscSupport::PetscOptions _petsc_options
PETSc option storage.
libMesh::StoredRange< MooseMesh::const_bnd_node_iterator, const BndNode * > * getBoundaryNodeRange()
virtual const std::vector< std::shared_ptr< Convergence > > & getConvergenceObjects(const THREAD_ID tid=0) const
Gets the Convergence objects.
void ErrorVector unsigned int
virtual void clearActiveElementalMooseVariables(const THREAD_ID tid) override
Clear the active elemental MooseVariableFEBase.
auto index_range(const T &sizable)
Base class for user-specific data.
void timestepSetup()
Calls the timestepSetup function for each of the output objects.
void allowOutput(bool state)
Ability to enable/disable all output calls.
virtual void cacheJacobian(const THREAD_ID tid)
virtual Sampler & getSampler(const std::string &name, const THREAD_ID tid=0)
virtual void outputStep(ExecFlagType type)
Output the current step.
virtual unsigned int nlSysNum(const NonlinearSystemName &nl_sys_name) const override
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
MooseEnum _verbose_setup
Whether or not to be verbose during setup.
static InputParameters validParams()
RedistributeProperties is used for its redistribute() callback, which ensures that any stateful prope...
unsigned int state
The state.
virtual void computeJacobianTags(const std::set< TagID > &tags)
Form multiple matrices, and each is associated with a tag.
void computeSystems(const ExecFlagType &type)
Do generic system computations.
MooseMesh * _displaced_mesh
void resize(unsigned int n_qpoints)
Resize the data to hold properties for n_qpoints quadrature points.
bool _has_mortar
Whether the simulation requires mortar coupling.
void computeLinearSystemTags(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags, const bool compute_gradients=true)
Compute the right hand side and the system matrix of the system for given tags.
libMesh::Order getMaxScalarOrder() const
void execTransfers(ExecFlagType type)
Execute the Transfers associated with the ExecFlagType.
void addNotZeroedVectorTag(const TagID tag)
Adds a vector tag to the list of vectors that will not be zeroed when other tagged vectors are...
void restoreState(bool verbose=false)
When a time step fails, this method is called to revert the current reporter values to their old stat...
void meshChanged()
Declares that the MooseMesh has changed, invalidates cached data and rebuilds caches.
void buildPRefinementAndCoarseningMaps(Assembly *assembly)
const std::vector< ConvergenceName > & getLinearConvergenceNames() const
Gets the linear convergence object name(s).
virtual void ghostGhostedBoundaries() override
Causes the boundaries added using addGhostedBoundary to actually be ghosted.
const ExecFlagType EXEC_POST_ADAPTIVITY
void add_ghosting_functor(GhostingFunctor &ghosting_functor)
MaterialWarehouse _materials
virtual void addJacobianScalar(const THREAD_ID tid=0)
virtual void addDiracKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
An instance of this object type has one copy per thread that runs on each thread. ...
MooseObjectWarehouse< IntegratedBCBase > _nonlocal_integrated_bcs
nonlocal integrated_bcs
virtual void computeResidualTag(const NumericVector< libMesh::Number > &soln, NumericVector< libMesh::Number > &residual, TagID tag)
Form a residual vector for a given tag.
virtual VectorMooseVariable & getVectorVariable(const THREAD_ID tid, const std::string &var_name) override
Returns the variable reference for requested VectorMooseVariable which may be in any system...
std::shared_ptr< LineSearch > _line_search
void initXFEM(std::shared_ptr< XFEMInterface > xfem)
Create XFEM controller object.
const std::set< SubdomainID > & meshSubdomains() const
Returns a read-only reference to the set of subdomains currently present in the Mesh.
SubdomainID getSubdomainID(const SubdomainName &subdomain_name) const
Get the associated subdomain ID for the subdomain name.
const FEType & type() const
Base class for all Transfer objects.
virtual void neighborSubdomainSetup(SubdomainID subdomain, const THREAD_ID tid)
void setupFiniteVolumeMeshData() const
Sets up the additional data needed for finite volume computations.
virtual void addCachedJacobian(const THREAD_ID tid) override
virtual void residualSetup(THREAD_ID tid=0) const
virtual void sizeZeroes(unsigned int size, const THREAD_ID tid)
virtual Real computeDamping(const NumericVector< libMesh::Number > &soln, const NumericVector< libMesh::Number > &update)
std::vector< Real > _real_zero
Convenience zeros.
MooseObjectWarehouse< KernelBase > _nonlocal_kernels
nonlocal kernels
void checkCoordinateSystems()
Verify that there are no element type/coordinate type conflicts.
unsigned int getMaxQps() const
const ExecFlagType EXEC_INITIAL
bool _verbose_multiapps
Whether or not to be verbose with multiapps.
Key structure for APIs manipulating global vectors/matrices.