87 #include "libmesh/nonlinear_solver.h" 88 #include "libmesh/quadrature_gauss.h" 89 #include "libmesh/dense_vector.h" 90 #include "libmesh/boundary_info.h" 91 #include "libmesh/petsc_matrix.h" 92 #include "libmesh/petsc_vector.h" 93 #include "libmesh/petsc_nonlinear_solver.h" 94 #include "libmesh/numeric_vector.h" 95 #include "libmesh/mesh.h" 96 #include "libmesh/dense_subvector.h" 97 #include "libmesh/dense_submatrix.h" 98 #include "libmesh/dof_map.h" 99 #include "libmesh/sparse_matrix.h" 100 #include "libmesh/petsc_matrix.h" 101 #include "libmesh/default_coupling.h" 102 #include "libmesh/diagonal_matrix.h" 103 #include "libmesh/fe_interface.h" 104 #include "libmesh/petsc_solver_exception.h" 107 #include <type_traits> 109 #include "petscsnes.h" 119 template <
typename T>
122 const std::string & system_name,
123 const unsigned int system_number,
125 std::vector<SetupInterface *> & results)
127 static_assert(std::is_base_of_v<MooseObject, T>);
128 static_assert(std::is_base_of_v<SetupInterface, T>);
130 std::vector<T *> objects;
132 .template condition<AttribSystem>(system_name)
133 .
template condition<AttribSysNum>(system_number)
134 .template condition<AttribThread>(tid)
137 for (
auto *
object : objects)
138 results.push_back(
object);
144 const std::string & name)
150 _residual_ghosted(NULL),
153 _Re_non_time_tag(-1),
155 _scalar_kernels(false),
157 _preset_nodal_bcs(false),
158 _ad_preset_nodal_bcs(false),
159 #ifdef MOOSE_KOKKOS_ENABLED
160 _kokkos_kernels(false),
161 _kokkos_integrated_bcs(false),
162 _kokkos_nodal_bcs(false),
163 _kokkos_preset_nodal_bcs(false),
164 _kokkos_nodal_kernels(false),
166 _general_dampers(false),
168 _increment_vec(NULL),
169 _use_finite_differenced_preconditioner(false),
170 _fdcoloring(nullptr),
172 _add_implicit_geometric_coupling_entries_to_jacobian(false),
173 _assemble_constraints_separately(false),
174 _need_residual_ghosted(false),
175 _debugging_residuals(false),
179 _n_residual_evaluations(0),
181 _computing_pre_smo_residual(false),
182 _pre_smo_residual(0),
183 _initial_residual(0),
184 _use_pre_smo_residual(false),
185 _print_all_var_norms(false),
187 _has_diag_save_in(false),
188 _has_nodalbc_save_in(false),
189 _has_nodalbc_diag_save_in(false),
190 _computed_scaling(false),
191 _compute_scaling_once(true),
192 _resid_vs_jac_scaling_param(0),
193 _off_diagonals_in_auto_scaling(false),
194 _auto_scaling_initd(false)
212 dof_map.set_implicit_neighbor_dofs(
false);
229 #ifdef MOOSE_KOKKOS_ENABLED 241 functor.second.setupMortarMaterials();
243 functor.second.setupMortarMaterials();
253 std::vector<SetupInterface *>
256 std::vector<SetupInterface *> fv_objects;
259 appendFVSetupObjects<FVElementalKernel>(
260 warehouse,
"FVElementalKernel",
number(), tid, fv_objects);
261 appendFVSetupObjects<FVFluxKernel>(warehouse,
"FVFluxKernel",
number(), tid, fv_objects);
262 appendFVSetupObjects<FVBoundaryCondition>(warehouse,
"FVDirichletBC",
number(), tid, fv_objects);
263 appendFVSetupObjects<FVBoundaryCondition>(warehouse,
"FVFluxBC",
number(), tid, fv_objects);
264 appendFVSetupObjects<FVInterfaceKernel>(
265 warehouse,
"FVInterfaceKernel",
number(), tid, fv_objects);
273 TIME_SECTION(
"nlInitialSetup", 2,
"Setting Up Nonlinear System");
278 TIME_SECTION(
"kernelsInitialSetup", 2,
"Setting Up Kernels/BCs/Constraints");
295 fv_object->initialSetup();
305 #ifdef MOOSE_KOKKOS_ENABLED 314 TIME_SECTION(
"mortarSetup", 2,
"Initializing Mortar Interfaces");
316 auto create_mortar_functors = [
this](
const bool displaced)
320 for (
const auto & [primary_secondary_boundary_pair, interface_config] : mortar_interfaces)
325 auto & mortar_constraints =
332 auto & mortar_functors =
335 mortar_functors.emplace(primary_secondary_boundary_pair,
337 *interface_config.amg,
345 create_mortar_functors(
false);
346 create_mortar_functors(
true);
380 fv_object->timestepSetup();
389 #ifdef MOOSE_KOKKOS_ENABLED 416 fv_object->customSetup(exec_type);
425 #ifdef MOOSE_KOKKOS_ENABLED 442 const std::string & name,
448 std::shared_ptr<KernelBase> kernel =
456 if (parameters.
get<std::vector<AuxVariableName>>(
"save_in").size() > 0)
458 if (parameters.
get<std::vector<AuxVariableName>>(
"diag_save_in").size() > 0)
464 const std::string & name,
481 const std::string & name,
487 std::shared_ptr<NodalKernelBase> kernel =
495 if (parameters.
have_parameter<std::vector<AuxVariableName>>(
"save_in") &&
496 parameters.
get<std::vector<AuxVariableName>>(
"save_in").size() > 0)
498 if (parameters.
have_parameter<std::vector<AuxVariableName>>(
"save_in") &&
499 parameters.
get<std::vector<AuxVariableName>>(
"diag_save_in").size() > 0)
505 const std::string & name,
508 std::shared_ptr<ScalarKernelBase> kernel =
518 const std::string & name,
525 std::shared_ptr<BoundaryCondition> bc =
530 const std::set<BoundaryID> & boundary_ids = bc->boundaryIDs();
532 _vars[tid].addBoundaryVar(boundary_ids, bc_var);
541 if (nbc->checkNodalVar() && !nbc->variable().isNodal())
542 mooseError(
"Trying to use nodal boundary condition '",
544 "' on a non-nodal variable '",
545 nbc->variable().name(),
551 _vars[tid].addBoundaryVars(boundary_ids, nbc->getCoupledVars());
553 if (parameters.get<std::vector<AuxVariableName>>(
"save_in").size() > 0)
555 if (parameters.get<std::vector<AuxVariableName>>(
"diag_save_in").size() > 0)
560 if (dbc && dbc->preset())
564 if (addbc && addbc->preset())
574 _vars[tid].addBoundaryVars(boundary_ids, ibc->getCoupledVars());
576 if (parameters.get<std::vector<AuxVariableName>>(
"save_in").size() > 0)
578 if (parameters.get<std::vector<AuxVariableName>>(
"diag_save_in").size() > 0)
590 const std::set<BoundaryID> & boundary_ids = bc->boundaryIDs();
591 _vars[tid].addBoundaryVar(boundary_ids, bc_var);
596 _vars[tid].addBoundaryVars(boundary_ids, ibc->getCoupledVars());
601 mooseError(
"Unknown BoundaryCondition type for object named ", bc->name());
606 const std::string & name,
614 if (constraint && constraint->addCouplingEntriesToJacobian())
620 const std::string & name,
625 std::shared_ptr<DiracKernelBase> kernel =
636 const std::string & name,
650 if (parameters.
get<std::vector<AuxVariableName>>(
"save_in").size() > 0)
652 if (parameters.
get<std::vector<AuxVariableName>>(
"diag_save_in").size() > 0)
658 const std::string & name,
663 std::shared_ptr<InterfaceKernelBase> interface_kernel =
667 const std::set<BoundaryID> & boundary_ids = interface_kernel->boundaryIDs();
669 _vars[tid].addBoundaryVar(boundary_ids, ik_var);
674 _vars[tid].addBoundaryVars(boundary_ids, interface_kernel->getCoupledVars());
680 const std::string & name,
708 const std::string & name,
717 std::shared_ptr<Split>
735 if (
_app.
parameters().
get<
bool>(
"use_legacy_initial_residual_evaluation_behavior"))
751 mooseError(
"pre-SMO residual is requested but not evaluated.");
803 parallel_object_only();
805 TIME_SECTION(
"nl::computeResidualTags", 5);
810 bool required_residual = tags.find(
residualVectorTag()) == tags.end() ? false :
true;
833 if (required_residual)
839 ti->postResidual(residual);
882 const std::set<TagID> & matrix_tags)
884 const bool required_residual =
894 if (required_residual)
900 ti->postResidual(residual);
938 TIME_SECTION(
"applyPredictor", 2,
"Applying Predictor");
944 _console <<
" Skipping predictor this step" << std::endl;
949 TIME_SECTION(
"initialBCs", 2,
"Applying BCs To Initial Condition");
952 for (
const auto & bnode : bnd_nodes)
955 Node * node = bnode->_node;
963 if (has_preset_nodal_bcs || has_ad_preset_nodal_bcs)
966 if (has_preset_nodal_bcs)
969 for (
const auto & preset_bc : preset_bcs)
970 preset_bc->computeValue(initial_solution);
972 if (has_ad_preset_nodal_bcs)
975 for (
const auto & preset_bc : preset_bcs_res)
976 preset_bc->computeValue(initial_solution);
982 #ifdef MOOSE_KOKKOS_ENABLED 1073 mooseError(
"The required residual vector is not available");
1085 for (
const auto & nc : ncs)
1087 std::vector<dof_id_type> & secondary_node_ids = nc->getSecondaryNodeId();
1088 std::vector<dof_id_type> & primary_node_ids = nc->getPrimaryNodeId();
1090 if ((secondary_node_ids.size() > 0) && (primary_node_ids.size() > 0))
1094 nc->computeResidual(residual);
1113 for (
const auto & nc : ncs)
1115 std::vector<dof_id_type> & secondary_node_ids = nc->getSecondaryNodeId();
1116 std::vector<dof_id_type> & primary_node_ids = nc->getPrimaryNodeId();
1118 if ((secondary_node_ids.size() > 0) && (primary_node_ids.size() > 0))
1122 nc->computeJacobian(jacobian_to_view);
1137 const bool displaced)
1142 const Elem * primary_elem =
info._elem;
1143 unsigned int primary_side =
info._side_num;
1144 std::vector<Point> points;
1145 points.push_back(
info._closest_point);
1166 const Elem *
const undisplaced_primary_elem =
1168 const Point undisplaced_primary_physical_point =
1169 [&points, displaced, primary_elem, undisplaced_primary_elem]()
1173 const Point reference_point =
1174 FEMap::inverse_map(primary_elem->dim(), primary_elem, points[0]);
1175 return FEMap::map(primary_elem->dim(), undisplaced_primary_elem, reference_point);
1184 undisplaced_primary_elem, primary_side, {undisplaced_primary_physical_point}, 0);
1201 "If we're calling this method with displaced = true, then we better well have a " 1202 "displaced problem");
1207 bool constraints_applied =
false;
1209 for (
const auto & it : penetration_locators)
1220 const auto & constraints =
1222 std::unordered_set<unsigned int> needed_mat_props;
1223 for (
const auto & constraint : constraints)
1225 const auto & mp_deps = constraint->getMatPropDependencies();
1226 needed_mat_props.insert(mp_deps.begin(), mp_deps.end());
1230 for (
unsigned int i = 0; i < secondary_nodes.size(); i++)
1232 dof_id_type secondary_node_num = secondary_nodes[i];
1243 for (
const auto & nfc : constraints)
1245 if (nfc->isExplicitConstraint())
1251 if (nfc->secondaryBoundary() != secondary_boundary ||
1252 nfc->primaryBoundary() != primary_boundary)
1255 if (nfc->shouldApply())
1257 constraints_applied =
true;
1258 nfc->computeSecondaryValue(
solution);
1261 if (nfc->hasWritableCoupledVariables())
1263 Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
1264 for (
auto * var : nfc->getWritableCoupledVariables())
1266 if (var->isNodalDefined())
1278 std::set<dof_id_type> unique_secondary_node_ids;
1286 const auto & constraints =
1290 unique_secondary_node_ids.clear();
1292 for (
const auto & elem :
as_range(meshhelper.active_subdomain_elements_begin(secondary_id),
1293 meshhelper.active_subdomain_elements_end(secondary_id)))
1295 for (
auto & n : elem->node_ref_range())
1296 unique_secondary_node_ids.insert(n.id());
1299 for (
auto secondary_node_id : unique_secondary_node_ids)
1313 for (
const auto & nec : constraints)
1315 if (nec->shouldApply())
1317 constraints_applied =
true;
1318 nec->computeSecondaryValue(
solution);
1330 if (constraints_applied)
1345 "If we're calling this method with displaced = true, then we better well have a " 1346 "displaced problem");
1351 bool constraints_applied;
1352 bool residual_has_inserted_values =
false;
1354 constraints_applied =
false;
1355 for (
const auto & it : penetration_locators)
1361 constraints_applied =
false;
1370 bool has_writable_variables(
false);
1374 const auto & constraints =
1377 for (
unsigned int i = 0; i < secondary_nodes.size(); i++)
1379 dof_id_type secondary_node_num = secondary_nodes[i];
1390 for (
const auto & nfc : constraints)
1396 if (nfc->secondaryBoundary() != secondary_boundary ||
1397 nfc->primaryBoundary() != primary_boundary)
1400 if (nfc->shouldApply())
1402 constraints_applied =
true;
1403 nfc->computeResidual();
1405 if (nfc->overwriteSecondaryResidual())
1411 const auto & secondary_var = nfc->variable();
1412 const auto & secondary_dofs = secondary_var.dofIndices();
1413 mooseAssert(secondary_dofs.size() == secondary_var.count(),
1414 "We are on a node so there should only be one dof per variable (for " 1415 "an ArrayVariable we should have a number of dofs equal to the " 1416 "number of components");
1422 std::vector<Number> values = {nfc->secondaryResidual()};
1423 residual.
insert(values, secondary_dofs);
1424 residual_has_inserted_values =
true;
1430 if (nfc->hasWritableCoupledVariables())
1432 Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
1433 has_writable_variables =
true;
1434 for (
auto * var : nfc->getWritableCoupledVariables())
1436 if (var->isNodalDefined())
1447 if (has_writable_variables)
1465 if (constraints_applied)
1470 if (residual_has_inserted_values)
1473 residual_has_inserted_values =
false;
1487 if (constraints_applied)
1492 if (residual_has_inserted_values)
1506 for (
const auto & it : element_pair_locators)
1513 const auto & element_constraints =
1517 const std::list<std::pair<const Elem *, const Elem *>> & elem_pairs =
1519 for (
const auto & pr : elem_pairs)
1521 const Elem * elem1 = pr.first;
1522 const Elem * elem2 = pr.second;
1530 for (
const auto & ec : element_constraints)
1537 ec->prepareShapes(ec->variable().number());
1538 ec->prepareNeighborShapes(ec->variable().number());
1541 ec->computeResidual();
1551 std::set<dof_id_type> unique_secondary_node_ids;
1553 constraints_applied =
false;
1554 residual_has_inserted_values =
false;
1555 bool has_writable_variables =
false;
1562 const auto & constraints =
1566 unique_secondary_node_ids.clear();
1568 for (
const auto & elem :
as_range(meshhelper.active_subdomain_elements_begin(secondary_id),
1569 meshhelper.active_subdomain_elements_end(secondary_id)))
1571 for (
auto & n : elem->node_ref_range())
1572 unique_secondary_node_ids.insert(n.id());
1575 for (
auto secondary_node_id : unique_secondary_node_ids)
1588 for (
const auto & nec : constraints)
1590 if (nec->shouldApply())
1592 constraints_applied =
true;
1593 nec->computeResidual();
1595 if (nec->overwriteSecondaryResidual())
1598 residual_has_inserted_values =
true;
1604 if (nec->hasWritableCoupledVariables())
1606 Threads::spin_mutex::scoped_lock lock(Threads::spin_mtx);
1607 has_writable_variables =
true;
1608 for (
auto * var : nec->getWritableCoupledVariables())
1610 if (var->isNodalDefined())
1623 if (constraints_applied)
1628 if (residual_has_inserted_values)
1639 if (has_writable_variables)
1662 for (
const auto & it : penetration_locators)
1672 const auto & constraints =
1676 const auto secondary_node_num = secondary_nodes[i];
1681 for (
const auto & nfc : constraints)
1683 if (!nfc->isExplicitConstraint())
1690 if (nfc->secondaryBoundary() != secondary_boundary ||
1691 nfc->primaryBoundary() != primary_boundary)
1694 nfc->overwriteBoundaryVariables(soln, secondary_node);
1705 TIME_SECTION(
"residualSetup", 3);
1728 #ifdef MOOSE_KOKKOS_ENABLED 1743 parallel_object_only();
1745 TIME_SECTION(
"computeResidualInternal", 3);
1751 std::vector<GeneralUserObject *> uos;
1757 for (
auto & uo : uos)
1758 uo->residualSetup();
1759 for (
auto & uo : uos)
1770 #ifdef MOOSE_KOKKOS_ENABLED 1778 TIME_SECTION(
"Kernels", 3 );
1783 Threads::parallel_reduce(elem_range, cr);
1795 Threads::parallel_reduce(faces, fvr);
1804 Threads::parallel_reduce(faces, fvr);
1820 TIME_SECTION(
"ScalarKernels", 3 );
1828 else if (tags.size() == 1)
1829 scalar_kernel_warehouse =
1835 bool have_scalar_contributions =
false;
1837 for (
const auto & scalar_kernel : scalars)
1839 scalar_kernel->reinit();
1840 const std::vector<dof_id_type> & dof_indices = scalar_kernel->variable().dofIndices();
1846 if (dof >= first_dof && dof < end_dof)
1848 scalar_kernel->computeResidual();
1849 have_scalar_contributions =
true;
1854 if (have_scalar_contributions)
1865 TIME_SECTION(
"NodalKernels", 3 );
1875 Threads::parallel_reduce(range, cnk);
1897 TIME_SECTION(
"NodalKernelBCs", 3 );
1903 Threads::parallel_reduce(bnd_node_range, cnk);
1965 const std::set<TagID> & matrix_tags)
1967 TIME_SECTION(
"computeResidualAndJacobianInternal", 3);
1972 for (
auto tag : matrix_tags)
1981 LibmeshPetscCall(MatSetOption(petsc_matrix->mat(),
1982 MAT_KEEP_NONZERO_PATTERN,
1986 MatSetOption(petsc_matrix->mat(), MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
1989 MAT_IGNORE_ZERO_ENTRIES,
1998 std::vector<UserObject *> uos;
2004 for (
auto & uo : uos)
2005 uo->residualSetup();
2006 for (
auto & uo : uos)
2017 #ifdef MOOSE_KOKKOS_ENABLED 2025 TIME_SECTION(
"Kernels", 3 );
2030 Threads::parallel_reduce(elem_range, crj);
2038 Threads::parallel_reduce(faces, fvrj);
2047 Threads::parallel_reduce(faces, fvr);
2069 for (
const auto & residual_vector_tag : residual_vector_tags)
2079 const std::set<TagID> & tags)
2091 #ifdef MOOSE_KOKKOS_ENABLED 2106 else if (tags.size() == 1)
2119 if (!bnd_nodes.
empty())
2121 TIME_SECTION(
"NodalBCs", 3 );
2123 for (
const auto & bnode : bnd_nodes)
2126 Node * node = bnode->_node;
2135 for (
const auto & nbc : bcs)
2136 if (nbc->shouldApply())
2137 nbc->computeResidual();
2162 else if (tags.size() == 1)
2183 std::map<std::string, std::set<unsigned int>> bc_involved_vars;
2185 for (
const auto & bid : all_boundary_ids)
2192 for (
const auto & bc : bcs)
2194 const std::vector<MooseVariableFEBase *> & coupled_moose_vars = bc->getCoupledMooseVars();
2198 std::set<unsigned int> & var_set = bc_involved_vars[bc->name()];
2199 for (
const auto & coupled_var : coupled_moose_vars)
2201 var_set.insert(coupled_var->number());
2203 var_set.insert(bc->variable().number());
2223 for (
const auto & bnode : bnd_nodes)
2226 Node * node = bnode->_node;
2234 for (
const auto & bc : bcs)
2237 std::set<unsigned int> & var_set = bc_involved_vars[bc->name()];
2243 for (
const auto & it : coupling_entries)
2245 unsigned int ivar = it.first->number(), jvar = it.second->number();
2251 if ((bc->variable().number() == ivar) && var_set.count(jvar) && bc->shouldApply())
2252 bc->computeOffDiagJacobian(jvar);
2255 const auto & coupled_scalar_vars = bc->getCoupledMooseScalarVars();
2256 for (
const auto & jvariable : coupled_scalar_vars)
2258 bc->computeOffDiagJacobianScalar(jvariable->number());
2271 [[maybe_unused]]
const std::set<TagID> & vector_tags,
2272 [[maybe_unused]]
const std::set<TagID> & matrix_tags)
2274 #ifdef MOOSE_KOKKOS_ENABLED 2287 if (!bnd_nodes.
empty())
2289 TIME_SECTION(
"NodalBCs", 3 );
2291 for (
const auto & bnode : bnd_nodes)
2294 Node * node = bnode->_node;
2303 for (
const auto & nbc : bcs)
2304 if (nbc->shouldApply())
2305 nbc->computeResidualAndJacobian();
2321 unsigned int s =
number();
2324 for (
unsigned int v = 0; v <
nVariables(); v++)
2325 for (
unsigned int c = 0; c < node.
n_comp(s, v); c++)
2333 std::unordered_map<
dof_id_type, std::vector<dof_id_type>> & graph)
2337 for (
const auto & it : nearest_node_locators)
2339 std::vector<dof_id_type> & secondary_nodes = it.second->_secondary_nodes;
2341 for (
const auto & secondary_node : secondary_nodes)
2343 std::set<dof_id_type> unique_secondary_indices;
2344 std::set<dof_id_type> unique_primary_indices;
2346 auto node_to_elem_pair = node_to_elem_map.find(secondary_node);
2347 if (node_to_elem_pair != node_to_elem_map.end())
2349 const std::vector<dof_id_type> & elems = node_to_elem_pair->second;
2352 for (
const auto & cur_elem : elems)
2354 std::vector<dof_id_type> dof_indices;
2357 for (
const auto & dof : dof_indices)
2358 unique_secondary_indices.insert(dof);
2362 std::vector<dof_id_type> primary_nodes = it.second->_neighbor_nodes[secondary_node];
2364 for (
const auto & primary_node : primary_nodes)
2366 auto primary_node_to_elem_pair = node_to_elem_map.find(primary_node);
2367 mooseAssert(primary_node_to_elem_pair != node_to_elem_map.end(),
2368 "Missing entry in node to elem map");
2369 const std::vector<dof_id_type> & primary_node_elems = primary_node_to_elem_pair->second;
2372 for (
const auto & cur_elem : primary_node_elems)
2374 std::vector<dof_id_type> dof_indices;
2377 for (
const auto & dof : dof_indices)
2378 unique_primary_indices.insert(dof);
2382 for (
const auto & secondary_id : unique_secondary_indices)
2383 for (
const auto & primary_id : unique_primary_indices)
2385 graph[secondary_id].push_back(primary_id);
2386 graph[primary_id].push_back(secondary_id);
2393 for (
const auto & nc : ncs)
2395 std::vector<dof_id_type> primary_dofs;
2396 std::vector<dof_id_type> & primary_node_ids = nc->getPrimaryNodeId();
2397 for (
const auto & node_id : primary_node_ids)
2408 std::vector<dof_id_type> secondary_dofs;
2409 std::vector<dof_id_type> & secondary_node_ids = nc->getSecondaryNodeId();
2410 for (
const auto & node_id : secondary_node_ids)
2421 for (
const auto & primary_id : primary_dofs)
2422 for (
const auto & secondary_id : secondary_dofs)
2424 graph[primary_id].push_back(secondary_id);
2425 graph[secondary_id].push_back(primary_id);
2430 for (
auto & it : graph)
2432 std::vector<dof_id_type> & row = it.second;
2433 std::sort(row.begin(), row.end());
2434 std::vector<dof_id_type>::iterator uit = std::unique(row.begin(), row.end());
2435 row.resize(uit - row.begin());
2449 std::unordered_map<dof_id_type, std::vector<dof_id_type>> graph;
2453 for (
const auto & it : graph)
2456 const auto & row = it.second;
2458 for (
const auto & coupled_dof : row)
2459 jacobian.add(dof, coupled_dof, 0);
2474 MAT_NEW_NONZERO_ALLOCATION_ERR,
2477 LibmeshPetscCall(MatSetOption(
2478 static_cast<PetscMatrix<Number> &
>(jacobian).mat(), MAT_IGNORE_ZERO_ENTRIES, PETSC_TRUE));
2480 std::vector<numeric_index_type> zero_rows;
2484 "If we're calling this method with displaced = true, then we better well have a " 2485 "displaced problem");
2490 bool constraints_applied;
2492 constraints_applied =
false;
2493 for (
const auto & it : penetration_locators)
2499 constraints_applied =
false;
2511 const auto & constraints =
2514 for (
const auto & secondary_node_num : secondary_nodes)
2527 for (
const auto & nfc : constraints)
2529 if (nfc->isExplicitConstraint())
2535 if (nfc->secondaryBoundary() != secondary_boundary ||
2536 nfc->primaryBoundary() != primary_boundary)
2539 nfc->_jacobian = &jacobian_to_view;
2541 if (nfc->shouldApply())
2543 constraints_applied =
true;
2549 nfc->prepareShapes(nfc->variable().number());
2550 nfc->prepareNeighborShapes(nfc->variable().number());
2552 nfc->computeJacobian();
2554 if (nfc->overwriteSecondaryJacobian())
2557 zero_rows.push_back(nfc->variable().nodalDofIndex());
2560 std::vector<dof_id_type> secondary_dofs(1, nfc->variable().nodalDofIndex());
2566 Real scaling_factor =
2567 nfc->overwriteSecondaryJacobian() ? 1. : nfc->variable().scalingFactor();
2573 nfc->_connected_dof_indices,
2577 if (nfc->addCouplingEntriesToJacobian())
2584 nfc->primaryVariable().dofIndicesNeighbor(),
2590 nfc->primaryVariable().dofIndicesNeighbor(),
2591 nfc->_connected_dof_indices,
2592 nfc->primaryVariable().scalingFactor());
2599 const std::vector<MooseVariableFEBase *> coupled_vars = nfc->getCoupledMooseVars();
2600 for (
const auto & jvar : coupled_vars)
2608 if (nfc->variable().number() == jvar->number() ||
2610 nfc->variable().number(), jvar->number(), this->
number()))
2618 nfc->prepareShapes(nfc->variable().number());
2619 nfc->prepareNeighborShapes(jvar->number());
2621 nfc->computeOffDiagJacobian(jvar->number());
2627 nfc->_connected_dof_indices,
2631 if (nfc->addCouplingEntriesToJacobian())
2638 jvar->dofIndicesNeighbor(),
2644 nfc->variable().dofIndicesNeighbor(),
2645 nfc->_connected_dof_indices,
2646 nfc->variable().scalingFactor());
2663 if (constraints_applied)
2666 MAT_KEEP_NONZERO_PATTERN,
2670 jacobian.zero_rows(zero_rows, 0.0);
2682 if (constraints_applied)
2685 MAT_KEEP_NONZERO_PATTERN,
2689 jacobian.zero_rows(zero_rows, 0.0);
2699 for (
const auto & it : element_pair_locators)
2706 const auto & element_constraints =
2710 const std::list<std::pair<const Elem *, const Elem *>> & elem_pairs =
2712 for (
const auto & pr : elem_pairs)
2714 const Elem * elem1 = pr.first;
2715 const Elem * elem2 = pr.second;
2723 for (
const auto & ec : element_constraints)
2735 ec->prepareShapes(ec->variable().number());
2736 ec->prepareNeighborShapes(ec->variable().number());
2739 ec->computeJacobian();
2749 std::set<dof_id_type> unique_secondary_node_ids;
2750 constraints_applied =
false;
2757 const auto & constraints =
2761 unique_secondary_node_ids.clear();
2763 for (
const auto & elem :
as_range(meshhelper.active_subdomain_elements_begin(secondary_id),
2764 meshhelper.active_subdomain_elements_end(secondary_id)))
2766 for (
auto & n : elem->node_ref_range())
2767 unique_secondary_node_ids.insert(n.id());
2770 for (
auto secondary_node_id : unique_secondary_node_ids)
2781 for (
const auto & nec : constraints)
2783 if (nec->shouldApply())
2785 constraints_applied =
true;
2792 nec->_jacobian = &jacobian_to_view;
2793 nec->prepareShapes(nec->variable().number());
2794 nec->prepareNeighborShapes(nec->variable().number());
2796 nec->computeJacobian();
2798 if (nec->overwriteSecondaryJacobian())
2801 zero_rows.push_back(nec->variable().nodalDofIndex());
2804 std::vector<dof_id_type> secondary_dofs(1, nec->variable().nodalDofIndex());
2810 nec->_connected_dof_indices,
2811 nec->variable().scalingFactor());
2816 nec->primaryVariable().dofIndicesNeighbor(),
2817 nec->_connected_dof_indices,
2818 nec->primaryVariable().scalingFactor());
2824 const std::vector<MooseVariableFEBase *> coupled_vars = nec->getCoupledMooseVars();
2825 for (
const auto & jvar : coupled_vars)
2833 if (nec->variable().number() == jvar->number() ||
2835 nec->variable().number(), jvar->number(), this->
number()))
2843 nec->prepareShapes(nec->variable().number());
2844 nec->prepareNeighborShapes(jvar->number());
2846 nec->computeOffDiagJacobian(jvar->number());
2852 nec->_connected_dof_indices,
2853 nec->variable().scalingFactor());
2858 nec->variable().dofIndicesNeighbor(),
2859 nec->_connected_dof_indices,
2860 nec->variable().scalingFactor());
2875 if (constraints_applied)
2878 MAT_KEEP_NONZERO_PATTERN,
2882 jacobian.zero_rows(zero_rows, 0.0);
2896 else if (tags.size() == 1)
2910 bool have_scalar_contributions =
false;
2911 for (
const auto & kernel : scalars)
2913 if (!kernel->computesJacobian())
2917 const std::vector<dof_id_type> & dof_indices = kernel->variable().dofIndices();
2923 if (dof >= first_dof && dof < end_dof)
2925 kernel->computeJacobian();
2927 have_scalar_contributions =
true;
2933 if (have_scalar_contributions)
2962 #ifdef MOOSE_KOKKOS_ENABLED 2977 TIME_SECTION(
"computeJacobianInternal", 3);
2984 for (
auto tag : tags)
2993 LibmeshPetscCall(MatSetOption(petsc_matrix->mat(),
2994 MAT_KEEP_NONZERO_PATTERN,
2998 MatSetOption(petsc_matrix->mat(), MAT_NEW_NONZERO_ALLOCATION_ERR, PETSC_FALSE));
3001 MAT_IGNORE_ZERO_ENTRIES,
3010 std::vector<UserObject *> uos;
3016 for (
auto & uo : uos)
3017 uo->jacobianSetup();
3018 for (
auto & uo : uos)
3029 #ifdef MOOSE_KOKKOS_ENABLED 3046 Threads::parallel_reduce(range, cnkjt);
3062 Threads::parallel_reduce(faces, fvj);
3071 Threads::parallel_reduce(faces, fvr);
3087 Threads::parallel_reduce(elem_range, cj);
3109 Threads::parallel_reduce(elem_range, cj);
3122 Threads::parallel_reduce(bnd_range, cnkjt);
3135 Threads::parallel_reduce(elem_range, cj);
3138 for (
unsigned int i = 0; i <
n_threads; i++)
3147 Threads::parallel_reduce(bnd_range, cnkjt);
3159 static bool first =
true;
3184 std::unique_ptr<SparseMatrix<Number>> hash_copy;
3186 auto make_readable_jacobian = [&]()
3188 #if PETSC_RELEASE_GREATER_EQUALS(3, 23, 0) 3189 if (system_matrix.use_hash_table())
3191 hash_copy = libMesh::cast_ref<PetscMatrix<Number> &>(system_matrix).copy_from_hash();
3192 view_jac_ptr = hash_copy.get();
3195 view_jac_ptr = &system_matrix;
3197 view_jac_ptr = &system_matrix;
3199 if (view_jac_ptr == &system_matrix)
3200 system_matrix.
close();
3203 make_readable_jacobian();
3207 if (had_nodal_constraints)
3209 make_readable_jacobian();
3245 for (
auto & tag : tags)
3264 TIME_SECTION(
"computeJacobianTags", 5);
3286 for (
auto & tag : tags)
3294 const std::set<TagID> & tags)
3296 TIME_SECTION(
"computeJacobianBlocks", 3);
3299 for (
unsigned int i = 0; i <
blocks.size(); i++)
3304 MAT_KEEP_NONZERO_PATTERN,
3308 MAT_NEW_NONZERO_ALLOCATION_ERR,
3321 Threads::parallel_reduce(elem_range, cjb);
3325 for (
unsigned int i = 0; i <
blocks.size(); i++)
3326 blocks[i]->_jacobian.close();
3328 for (
unsigned int i = 0; i <
blocks.size(); i++)
3333 unsigned int ivar =
blocks[i]->_ivar;
3334 unsigned int jvar =
blocks[i]->_jvar;
3337 std::vector<numeric_index_type> zero_rows;
3341 for (
const auto & bnode : bnd_nodes)
3344 Node * node = bnode->_node;
3354 for (
const auto & bc : bcs)
3355 if (bc->variable().number() == ivar && bc->shouldApply())
3401 #ifdef MOOSE_KOKKOS_ENABLED 3417 bool has_active_dampers =
false;
3425 TIME_SECTION(
"computeDampers", 3,
"Computing Dampers");
3426 has_active_dampers =
true;
3439 TIME_SECTION(
"computeDamping::element", 3,
"Computing Element Damping");
3441 has_active_dampers =
true;
3454 TIME_SECTION(
"computeDamping::general", 3,
"Computing General Damping");
3456 has_active_dampers =
true;
3458 for (
const auto & damper : gdampers)
3463 damper->checkMinDamping(gd_damping);
3469 damping =
std::min(gd_damping, damping);
3481 catch (std::exception & e)
3484 const std::string & message = e.what();
3485 if (message.find(
"Jacobian") == std::string::npos)
3491 if (has_active_dampers && damping < 1.0)
3492 _console <<
" Damping factor: " << damping << std::endl;
3502 std::set<const Elem *> dirac_elements;
3506 TIME_SECTION(
"computeDirac", 3,
"Computing DiracKernels");
3512 for (
const auto & dkernel : dkernels)
3514 dkernel->clearPoints();
3515 dkernel->addPoints();
3523 DistElemRange range(dirac_elements.begin(), dirac_elements.end(), 1);
3576 std::vector<dof_id_type> & n_nz,
3577 std::vector<dof_id_type> & n_oz)
3583 std::unordered_map<dof_id_type, std::vector<dof_id_type>> graph;
3598 for (
const auto & git : graph)
3603 if (dof < first_dof_on_proc || dof >= end_dof_on_proc)
3606 const auto & row = git.second;
3610 unsigned int original_row_length = sparsity_row.size();
3612 sparsity_row.insert(sparsity_row.end(), row.begin(), row.end());
3614 SparsityPattern::sort_row(
3615 sparsity_row.begin(), sparsity_row.begin() + original_row_length, sparsity_row.end());
3618 for (
const auto & coupled_dof : row)
3620 if (coupled_dof < first_dof_on_proc || coupled_dof >= end_dof_on_proc)
3622 if (n_oz[local_dof] < n_dofs_not_on_proc)
3627 if (n_nz[local_dof] < n_dofs_on_proc)
3663 mooseError(
"More than one active Preconditioner detected");
3682 const std::set<MooseVariable *> & damped_vars)
3684 for (
const auto & var : damped_vars)
3690 const std::set<MooseVariable *> & damped_vars)
3692 for (
const auto & var : damped_vars)
3700 std::set<SubdomainID> input_subdomains;
3701 std::set<std::string> kernel_variables;
3703 bool global_kernels_exist =
false;
3713 #ifdef MOOSE_KOKKOS_ENABLED 3720 std::vector<FVElementalKernel *> fv_elemental_kernels;
3723 .template condition<AttribSystem>(
"FVElementalKernel")
3724 .queryInto(fv_elemental_kernels);
3726 for (
auto fv_kernel : fv_elemental_kernels)
3728 if (fv_kernel->blockRestricted())
3729 for (
auto block_id : fv_kernel->blockIDs())
3730 input_subdomains.insert(block_id);
3732 global_kernels_exist =
true;
3733 kernel_variables.insert(fv_kernel->variable().name());
3736 if (dynamic_cast<FVScalarLagrangeMultiplierConstraint *>(fv_kernel))
3737 kernel_variables.insert(dynamic_cast<FVScalarLagrangeMultiplierConstraint *>(fv_kernel)
3742 std::vector<FVFluxKernel *> fv_flux_kernels;
3745 .template condition<AttribSystem>(
"FVFluxKernel")
3746 .queryInto(fv_flux_kernels);
3748 for (
auto fv_kernel : fv_flux_kernels)
3750 if (fv_kernel->blockRestricted())
3751 for (
auto block_id : fv_kernel->blockIDs())
3752 input_subdomains.insert(block_id);
3754 global_kernels_exist =
true;
3755 kernel_variables.insert(fv_kernel->variable().name());
3758 std::vector<FVInterfaceKernel *> fv_interface_kernels;
3761 .template condition<AttribSystem>(
"FVInterfaceKernel")
3762 .queryInto(fv_interface_kernels);
3764 for (
auto fvik : fv_interface_kernels)
3765 if (
auto scalar_fvik = dynamic_cast<FVScalarLagrangeMultiplierInterface *>(fvik))
3766 kernel_variables.insert(scalar_fvik->lambdaVariable().name());
3768 std::vector<FVFluxBC *> fv_flux_bcs;
3771 .template condition<AttribSystem>(
"FVFluxBC")
3772 .queryInto(fv_flux_bcs);
3774 for (
auto fvbc : fv_flux_bcs)
3775 if (
auto scalar_fvbc = dynamic_cast<FVBoundaryScalarLagrangeMultiplierConstraint *>(fvbc))
3776 kernel_variables.insert(scalar_fvbc->lambdaVariable().name());
3781 const auto additional_variables_covered = ibc->additionalROVariables();
3782 kernel_variables.insert(additional_variables_covered.begin(),
3783 additional_variables_covered.end());
3787 if (!global_kernels_exist)
3789 std::set<SubdomainID> difference;
3790 std::set_difference(mesh_subdomains.begin(),
3791 mesh_subdomains.end(),
3792 input_subdomains.begin(),
3793 input_subdomains.end(),
3794 std::inserter(difference, difference.end()));
3798 difference.erase(
id);
3800 difference.erase(
id);
3802 if (!difference.empty())
3804 std::vector<SubdomainID> difference_vec =
3805 std::vector<SubdomainID>(difference.begin(), difference.end());
3807 std::stringstream missing_block_names;
3808 std::copy(difference_names.begin(),
3809 difference_names.end(),
3810 std::ostream_iterator<std::string>(missing_block_names,
" "));
3811 std::stringstream missing_block_ids;
3812 std::copy(difference.begin(),
3814 std::ostream_iterator<unsigned int>(missing_block_ids,
" "));
3816 mooseError(
"Each subdomain must contain at least one Kernel.\nThe following block(s) lack an " 3818 missing_block_names.str(),
3820 missing_block_ids.str(),
3828 std::set<VariableName> difference;
3829 std::set_difference(variables.begin(),
3831 kernel_variables.begin(),
3832 kernel_variables.end(),
3833 std::inserter(difference, difference.end()));
3836 std::set<VariableName>
vars(difference);
3837 for (
auto & var_name :
vars)
3840 for (
const auto &
id : blks)
3842 difference.erase(var_name);
3845 if (!difference.empty())
3847 std::stringstream missing_kernel_vars;
3848 std::copy(difference.begin(),
3850 std::ostream_iterator<std::string>(missing_kernel_vars,
" "));
3851 mooseError(
"Each variable must be referenced by at least one active Kernel.\nThe following " 3852 "variable(s) lack an active kernel: " +
3853 missing_kernel_vars.str());
3865 std::vector<std::string>
3868 std::vector<std::string> variable_names;
3870 if (time_kernels.hasActiveObjects())
3871 for (
const auto & kernel : time_kernels.getObjects())
3872 variable_names.push_back(kernel->variable().name());
3874 return variable_names;
3884 if (std::static_pointer_cast<MaterialPropertyInterface>(bc)->getMaterialPropertyCalled())
3891 if (std::static_pointer_cast<MaterialPropertyInterface>(ik)->getMaterialPropertyCalled())
3899 if (
auto mpi = std::dynamic_pointer_cast<MaterialPropertyInterface>(ct);
3900 mpi && mpi->getMaterialPropertyCalled())
3912 if (std::static_pointer_cast<MaterialPropertyInterface>(ik)->getMaterialPropertyCalled())
3924 if (std::static_pointer_cast<MaterialPropertyInterface>(dg)->getMaterialPropertyCalled())
3947 const std::set<TagID> & vector_tags,
3948 const std::set<TagID> & matrix_tags)
3950 parallel_object_only();
3955 map_pr.second(compute_type, vector_tags, matrix_tags);
3958 map_pr.second(compute_type, vector_tags, matrix_tags);
3960 catch (MetaPhysicL::LogicError &)
3963 "We caught a MetaPhysicL error in NonlinearSystemBase::mortarConstraints. This is very " 3964 "likely due to AD not having a sufficiently large derivative container size. Please run " 3965 "MOOSE configure with the '--with-derivative-size=<n>' option");
3988 std::set<unsigned int> var_numbers, var_numbers_covered, var_numbers_not_covered;
3990 var_numbers.insert(var_number);
4000 "', provided to the 'scaling_group_variables' parameter, does not exist in " 4001 "the nonlinear system.");
4008 if (!map_pair.second)
4009 mooseError(
"Variable ", var_name,
" is contained in multiple scaling grouplings");
4010 var_numbers_covered.insert(var.
number());
4013 std::set_difference(var_numbers.begin(),
4015 var_numbers_covered.begin(),
4016 var_numbers_covered.end(),
4017 std::inserter(var_numbers_not_covered, var_numbers_not_covered.begin()));
4022 for (
auto var_number : var_numbers_not_covered)
4027 const auto & number_to_var_map =
_vars[0].numberToVariableMap();
4033 libmesh_map_find(number_to_var_map, i)->name()) !=
4046 _console <<
"\nPerforming automatic scaling calculation\n" << std::endl;
4048 TIME_SECTION(
"computeScaling", 3,
"Computing Automatic Scaling");
4055 std::vector<dof_id_type> dof_indices;
4063 auto & dof_map =
dofMap();
4107 auto examine_dof_indices = [
this,
4111 &jac_inverse_scaling_factors,
4112 &resid_inverse_scaling_factors,
4113 &scaling_residual](
const auto & dof_indices,
const auto var_number)
4115 for (
auto dof_index : dof_indices)
4116 if (dof_map.local_index(dof_index))
4121 auto mat_value = (*_scaling_matrix)(dof_index, dof_index);
4127 auto vec_value = scaling_residual(dof_index);
4139 dof_map.dof_indices(elem, dof_indices, i);
4140 examine_dof_indices(dof_indices, i);
4146 dof_map.SCALAR_dof_indices(dof_indices, i);
4147 examine_dof_indices(dof_indices, i);
4155 if (jac_scaling && resid_scaling)
4156 for (MooseIndex(inverse_scaling_factors) i = 0; i < inverse_scaling_factors.size(); ++i)
4159 if (!resid_inverse_scaling_factors[i])
4161 if (!jac_inverse_scaling_factors[i])
4162 inverse_scaling_factors[i] = 1;
4164 inverse_scaling_factors[i] = jac_inverse_scaling_factors[i];
4166 else if (!jac_inverse_scaling_factors[i])
4168 inverse_scaling_factors[i] = resid_inverse_scaling_factors[i];
4170 inverse_scaling_factors[i] =
4174 else if (jac_scaling)
4175 inverse_scaling_factors = jac_inverse_scaling_factors;
4176 else if (resid_scaling)
4177 inverse_scaling_factors = resid_inverse_scaling_factors;
4179 mooseError(
"We shouldn't be calling this routine if we're not performing any scaling");
4182 for (
auto & scaling_factor : inverse_scaling_factors)
4183 if (scaling_factor == 0)
4187 std::vector<Real> flattened_inverse_scaling_factors(
system().
n_vars());
4188 for (
const auto i :
index_range(flattened_inverse_scaling_factors))
4189 flattened_inverse_scaling_factors[i] = inverse_scaling_factors[
_var_to_group_var[i]];
4195 flattened_inverse_scaling_factors);
4208 auto & scaling_vector =
getVector(
"scaling_factors");
4211 const auto & dof_map =
dofMap();
4213 const auto & field_variables =
_vars[0].fieldVariables();
4214 const auto & scalar_variables =
_vars[0].scalars();
4216 std::vector<dof_id_type> dof_indices;
4218 for (
const Elem *
const elem :
4219 as_range(lm_mesh.active_local_elements_begin(), lm_mesh.active_local_elements_end()))
4220 for (
const auto *
const field_var : field_variables)
4222 const auto & factors = field_var->arrayScalingFactor();
4223 for (
const auto i :
make_range(field_var->count()))
4225 dof_map.dof_indices(elem, dof_indices, field_var->number() + i);
4226 for (
const auto dof : dof_indices)
4227 scaling_vector.set(dof, factors[i]);
4231 for (
const auto *
const scalar_var : scalar_variables)
4233 mooseAssert(scalar_var->count() == 1,
4234 "Scalar variables should always have only one component.");
4235 dof_map.SCALAR_dof_indices(dof_indices, scalar_var->number());
4236 for (
const auto dof : dof_indices)
4237 scaling_vector.set(dof, scalar_var->scalingFactor());
4241 scaling_vector.close();
4263 if (!scaling_succeeded)
4278 LibmeshPetscCall(MatFDColoringDestroy(&
_fdcoloring));
4285 mooseError(
"No field split preconditioner is present for this system");
std::string name(const ElemQuality q)
std::vector< std::shared_ptr< TimeIntegrator > > _time_integrators
Time integrator.
virtual void setSolutionUDotDotOld(const NumericVector< Number > &u_dotdot_old)
virtual void reinitNeighborPhys(const Elem *neighbor, unsigned int neighbor_side, const std::vector< Point > &physical_points, const THREAD_ID tid)=0
virtual void residualSetup(THREAD_ID tid=0) const
NumericVector< Number > & getResidualTimeVector()
Return a numeric vector that is associated with the time tag.
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.
MooseObjectTagWarehouse< NodalKernelBase > _nodal_kernels
NodalKernels for each thread.
NumericVector< Number > * _Re_time
residual vector for time contributions
void computeJacobianBlocks(std::vector< JacobianBlock *> &blocks)
Computes several Jacobian blocks simultaneously, summing their contributions into smaller preconditio...
virtual void insert(const T *v, const std::vector< numeric_index_type > &dof_indices)
MetaPhysicL::DualNumber< V, D, asd > abs(const MetaPhysicL::DualNumber< V, D, asd > &a)
TagID _Re_time_tag
Tag for time contribution residual.
void allgather(const T &send_data, std::vector< T, A > &recv_data) const
std::map< std::pair< BoundaryID, BoundaryID >, PenetrationLocator * > _penetration_locators
dof_id_type end_dof(const processor_id_type proc) const
virtual void addKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
Adds a kernel.
virtual void setSolutionUDotDot(const NumericVector< Number > &udotdot)
Set transient term used by residual and Jacobian evaluation.
dof_id_type dof_number(const unsigned int s, const unsigned int var, const unsigned int comp) const
Base kernel for hybridized finite element formulations.
MooseObjectTagWarehouse< ResidualObject > _kokkos_nodal_kernels
KOKKOS_INLINE_FUNCTION const T * find(const T &target, const T *const begin, const T *const end)
Find a value in an array.
void reinitIncrementAtNodeForDampers(THREAD_ID tid, const std::set< MooseVariable *> &damped_vars)
Compute the incremental change in variables at nodes for dampers.
void overwriteNodeFace(NumericVector< Number > &soln)
Called from explicit time stepping to overwrite boundary positions (explicit dynamics).
Base class for deriving general dampers.
bool _use_pre_smo_residual
Whether to use the pre-SMO initial residual in the relative convergence check.
MoosePreconditioner const * getPreconditioner() const
virtual const char * what() const
Get out the error message.
void findImplicitGeometricCouplingEntries(GeometricSearchData &geom_search_data, std::unordered_map< dof_id_type, std::vector< dof_id_type >> &graph)
Finds the implicit sparsity graph between geometrically related dofs.
void setupDampers()
Setup damping stuff (called before we actually start)
Real _initial_residual
The initial (i.e., 0th nonlinear iteration) residual, see setPreSMOResidual for a detailed explanatio...
std::vector< bool > _variable_autoscaled
Container to hold flag if variable is to participate in autoscaling.
void zeroVectorForResidual(const std::string &vector_name)
virtual void cacheResidualNeighbor(const THREAD_ID tid) override
bool identifyVariableGroupsInNL() const
Whether to identify variable groups in nonlinear systems.
void zeroTaggedVectors(const std::set< TagID > &tags)
Zero all vectors for given tags.
const std::set< SubdomainID > & interiorLowerDBlocks() const
Base class for split-based preconditioners.
bool hasActiveBlockObjects(THREAD_ID tid=0) const
std::shared_ptr< DisplacedProblem > displaced_problem
bool hasVector(const std::string &tag_name) const
Check if the named vector exists in the system.
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...
unsigned int n_comp(const unsigned int s, const unsigned int var) const
void applyScalingFactors(const std::vector< Real > &inverse_scaling_factors)
Applies scaling factors to the system's variables.
bool _debugging_residuals
true if debugging residuals
BoundaryID _secondary_boundary
NumericVector< Number > * _Re_non_time
residual vector for non-time contributions
const std::map< SubdomainID, std::vector< std::shared_ptr< T > > > & getActiveBlockObjects(THREAD_ID tid=0) const
MooseObjectTagWarehouse< ResidualObject > _kokkos_kernels
Real computeDamping(const NumericVector< Number > &solution, const NumericVector< Number > &update)
Compute damping.
virtual void reinitNode(const Node *node, const THREAD_ID tid) override
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.
bool _assemble_constraints_separately
Whether or not to assemble the residual and Jacobian after the application of each constraint...
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.
MooseObjectTagWarehouse< DGKernelBase > _dg_kernels
virtual bool haveFV() const override
returns true if this problem includes/needs finite volume functionality.
face_info_iterator ownedFaceInfoBegin()
Iterators to owned faceInfo objects.
void reinitIncrementAtQpsForDampers(THREAD_ID tid, const std::set< MooseVariable *> &damped_vars)
Compute the incremental change in variables at QPs for dampers.
void computeResidualAndJacobianInternal(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
Compute residual and Jacobian from contributions not related to constraints, such as nodal boundary c...
bool useHashTableMatrixAssembly() const
void addImplicitGeometricCouplingEntriesToJacobian(bool add=true)
If called with true this will add entries into the jacobian to link together degrees of freedom that ...
void dof_indices(const Elem *const elem, std::vector< dof_id_type > &di) const
bool areCoupled(const unsigned int ivar, const unsigned int jvar, const unsigned int nl_sys_num) const
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application...
void accumulateIterationIntoTimeStepOccurences()
Pass the number of solution invalid occurrences from current iteration to cumulative counters...
unsigned int number() const
Get variable number coming from libMesh.
virtual void initialSetup() override
Setup Functions.
Data structure used to hold penetration information.
const std::vector< std::shared_ptr< NodalConstraint > > & getActiveNodalConstraints() const
Access methods for active objects.
NumericVector< Number > * _u_dot_old
old solution vector for u^dot
bool _has_nodalbc_diag_save_in
If there is a nodal BC having diag_save_in.
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
Base class for automatic differentiation Dirichlet BCs.
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...
virtual void getDiracElements(std::set< const Elem *> &elems) override
Fills "elems" with the elements that should be looped over for Dirac Kernels.
void setupDM()
Setup the PETSc DM object (when appropriate)
void setCurrentlyComputingResidual(bool currently_computing_residual) final
Set whether or not the problem is in the process of computing the residual.
void checkKernelCoverage(const std::set< SubdomainID > &mesh_subdomains) const
void addDGKernel(std::string dg_kernel_name, const std::string &name, InputParameters ¶meters)
Adds a DG kernel.
void computeJacobian(libMesh::SparseMatrix< Number > &jacobian, const std::set< TagID > &tags)
Associate jacobian to systemMatrixTag, and then form a matrix for all the tags.
const InputParameters & parameters() const
Get the parameters of the object.
virtual void reinitNeighborPhys(const Elem *neighbor, unsigned int neighbor_side, const std::vector< Point > &physical_points, const THREAD_ID tid) override
void computeKokkosResidualAndJacobian(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
virtual TagID addVectorTag(const TagName &tag_name, const Moose::VectorTagType type=Moose::VECTOR_TAG_RESIDUAL)
Create a Tag.
void getNodeDofs(dof_id_type node_id, std::vector< dof_id_type > &dofs)
Base class for all Constraint types.
std::set< TagID > _nl_vector_tags
Vector tags to temporarily store all tags associated with the current system.
std::vector< std::string > _ignore_variables_for_autoscaling
A container for variables that do not partipate in autoscaling.
void residualSetup() override
Base boundary condition of a Dirichlet type.
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
MooseObjectTagWarehouse< NodalBCBase > _nodal_bcs
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...
const std::vector< std::shared_ptr< NodeFaceConstraint > > & getActiveNodeFaceConstraints(BoundaryID boundary_id, bool displaced) const
virtual void customSetup(const ExecFlagType &exec_type, THREAD_ID tid=0) const
MooseObjectWarehouse< T > & getVectorTagsObjectWarehouse(const std::set< TagID > &tags, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object at least has one of the given vector ta...
virtual const Node * queryNodePtr(const dof_id_type i) const
const ElementPairInfo & getElemPairInfo(std::pair< const Elem *, const Elem *> elem_pair) const
MooseObjectWarehouseBase< Split > _splits
Decomposition splits.
NumericVector< Number > * _u_dotdot
solution vector for u^dotdot
bool hasActiveMortarConstraints(const std::pair< BoundaryID, BoundaryID > &mortar_interface_key, bool displaced) const
const Parallel::Communicator & comm() const
NumericVector< Number > & add_vector(std::string_view vec_name, const bool projections=true, const ParallelType type=PARALLEL)
Solving a linear problem.
bool _has_nodalbc_save_in
If there is a nodal BC having save_in.
bool hasActiveNodalConstraints() const
Deterimine if active objects exist.
virtual void prepareAssemblyNeighbor(const THREAD_ID tid)
Begin a fresh neighbor accumulation phase by sizing and zeroing the neighbor blocks.
virtual bool hasMatrix(TagID tag) const
Check if the tagged matrix exists in the system.
MooseObjectWarehouse< NodalDamper > _nodal_dampers
Nodal Dampers for each thread.
void computeNodalBCsResidualAndJacobian(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
Compute the residual and Jacobian together for nodal boundary conditions.
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.
virtual libMesh::NonlinearSolver< Number > * nonlinearSolver()=0
dof_id_type n_dofs(const unsigned int vn) const
Real preSMOResidual() const
The pre-SMO residual.
std::unique_ptr< libMesh::DiagonalMatrix< Number > > _scaling_matrix
A diagonal matrix used for computing scaling.
virtual void setSolutionUDotOld(const NumericVector< Number > &u_dot_old)
virtual void associateMatrixToTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Associate a matrix to a tag.
bool hasDiagSaveIn() const
Weather or not the nonlinear system has diagonal Jacobian save-ins.
This class provides an interface for common operations on field variables of both FE and FV types wit...
const Parallel::Communicator & _communicator
void updateActive(THREAD_ID tid=0) override
Update the various active lists.
Real initialResidual() const
The initial residual.
The following methods are specializations for using the libMesh::Parallel::packed_range_* routines fo...
bool needInterfaceMaterialOnSide(BoundaryID bnd_id, THREAD_ID tid) const
Indicated whether this system needs material properties on interfaces.
const libMesh::ConstElemRange & getCurrentAlgebraicElementRange()
These are the element and nodes that contribute to the jacobian and residual for this local processor...
MooseObjectWarehouse< ResidualObject > _kokkos_preset_nodal_bcs
std::size_t _num_scaling_groups
The number of scaling groups.
const libMesh::ConstNodeRange & getCurrentAlgebraicNodeRange()
void computingScalingJacobian(bool computing_scaling_jacobian)
Setter for whether we're computing the scaling jacobian.
dof_id_type n_local_dofs(const unsigned int vn) const
virtual void updateActive(THREAD_ID tid=0) override
Update the active status of Kernels.
bool has_dofs(const unsigned int s=libMesh::invalid_uint) const
std::map< dof_id_type, PenetrationInfo * > & _penetration_info
Data structure of nodes and their associated penetration information.
bool hasActiveNodeElemConstraints(SubdomainID secondary_id, SubdomainID primary_id, bool displaced) const
Real _pre_smo_residual
The pre-SMO residual, see setPreSMOResidual for a detailed explanation.
bool hasDampers()
Whether or not this system has dampers.
const std::vector< std::shared_ptr< NodeElemConstraintBase > > & getActiveNodeElemConstraints(SubdomainID secondary_id, SubdomainID primary_id, bool displaced) const
bool _compute_scaling_once
Whether the scaling factors should only be computed once at the beginning of the simulation through a...
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.
bool _has_save_in
If there is any Kernel or IntegratedBC having save_in.
virtual const Node & nodeRef(const dof_id_type i) const
TagID _Ke_system_tag
Tag for system contribution Jacobian.
virtual void setResidual(NumericVector< libMesh::Number > &residual, const THREAD_ID tid) override
std::vector< SetupInterface * > getFVSetupObjects(THREAD_ID tid)
Retrieve every finite volume object belonging to this system on thread tid, as SetupInterfaces, so that the setup methods can be dispatched to all finite volume families with a single loop.
dof_id_type n_dofs() const
virtual void disassociateMatrixFromTag(libMesh::SparseMatrix< Number > &matrix, TagID tag)
Disassociate a matrix from a tag.
Scope guard for starting and stopping Floating Point Exception Trapping.
auto max(const L &left, const R &right)
Serves as a base class for DGKernel and ADDGKernel.
const Variable & variable(const unsigned int c) const override
void constraintResiduals(NumericVector< Number > &residual, bool displaced)
Add residual contributions from Constraints.
Base class for MOOSE preconditioners.
NumericVector< Number > & addVector(const std::string &vector_name, const bool project, const libMesh::ParallelType type)
Adds a solution length vector to the system.
virtual GeometricSearchData & geomSearchData() override
std::unordered_map< std::pair< BoundaryID, BoundaryID >, ComputeMortarFunctor > _undisplaced_mortar_functors
Functors for computing undisplaced mortar constraints.
Specialization for filling multiple "small" preconditioning matrices simulatenously.
virtual bool matrixFromColoring() const
Whether a system matrix is formed from coloring.
void update()
Update the system (doing libMesh magic)
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num) override
void addScalarKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
Adds a scalar kernel.
void addBoundaryCondition(const std::string &bc_name, const std::string &name, InputParameters ¶meters)
Adds a boundary condition.
bool hasActiveNodeFaceConstraints(BoundaryID boundary_id, bool displaced) const
void computeResidual(NumericVector< Number > &residual, TagID tag_id)
Form a residual vector for a given tag.
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...
virtual unsigned int nVariables() const
Get the number of variables in this system.
EXTERN_C_BEGIN PetscErrorCode DMCreate_Moose(DM)
bool hasActiveBoundaryObjects(THREAD_ID tid=0) const
bool _need_residual_ghosted
Whether or not a ghosted copy of the residual needs to be made.
virtual void activateAllMatrixTags()
Make all existing matrices active.
virtual const std::string & name() const
virtual void jacobianSetup()
virtual bool containsTimeKernel() override
If the system has a kernel that corresponds to a time derivative.
void onTimestepBegin()
Called at the beginning of the time step.
const ConstBndNodeRange & getCurrentAlgebraicBndNodeRange()
std::vector< dof_id_type, Threads::scalable_allocator< dof_id_type > > Row
MooseObjectTagWarehouse< DiracKernelBase > _dirac_kernels
Dirac Kernel storage for each thread.
void closeTaggedMatrices(const std::set< TagID > &tags)
Close all matrices associated the tags.
TagID _Re_non_time_tag
Tag for non-time contribution residual.
std::set< TagID > _nl_matrix_tags
Matrix tags to temporarily store all tags associated with the current system.
void set_basic_system_only()
std::map< std::pair< BoundaryID, BoundaryID >, NearestNodeLocator * > _nearest_node_locators
void setPredictor(std::shared_ptr< Predictor > predictor)
Real _resid_vs_jac_scaling_param
The param that indicates the weighting of the residual vs the Jacobian in determining variable scalin...
bool _auto_scaling_initd
Whether we've initialized the automatic scaling data structures.
virtual void computeScalingResidual()=0
Compute a "residual" for automatic scaling purposes.
bool _doing_dg
true if DG is active (optimization reasons)
virtual libMesh::DofMap & dofMap()
Gets writeable reference to the dof map.
void syncIteration()
Sync iteration counts to main processor Sum across all processors.
virtual void deactivateAllMatrixTags()
Make matrices inactive.
void computeNodalBCsResidual(NumericVector< Number > &residual)
Enforces nodal boundary conditions.
unsigned int number() const
void computeResidualAndJacobianTags(const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
Form possibly multiple tag-associated vectors and matrices.
bool needBoundaryMaterialOnSide(BoundaryID bnd_id, THREAD_ID tid) const
Indicated whether this system needs material properties on boundaries.
MooseObjectWarehouse< DirichletBCBase > _preset_nodal_bcs
std::unordered_map< unsigned int, unsigned int > _var_to_group_var
A map from variable index to group variable index and it's associated (inverse) scaling factor...
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...
std::vector< unsigned int > _current_l_its
virtual std::unique_ptr< Base > create()=0
void setCurrentNonlinearSystem(const unsigned int nl_sys_num)
std::shared_ptr< T > getActiveObject(const std::string &name, THREAD_ID tid=0) const
This is the common base class for the three main kernel types implemented in MOOSE, Kernel, VectorKernel and ArrayKernel.
std::vector< dof_id_type > _secondary_nodes
MeshBase & getMesh()
Accessor for the underlying libMesh Mesh object.
void min(const T &r, T &o, Request &req) const
void computeDiracContributions(const std::set< TagID > &tags, bool is_jacobian)
void updateActive(THREAD_ID tid)
Update active objects of Warehouses owned by NonlinearSystemBase.
TheWarehouse & theWarehouse() const
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
const ElementPairList & getElemPairs() const
FieldSplitPreconditionerBase & getFieldSplitPreconditioner()
std::unordered_map< std::pair< BoundaryID, BoundaryID >, ComputeMortarFunctor > _displaced_mortar_functors
Functors for computing displaced mortar constraints.
bool enforceNodalConstraintsJacobian(const SparseMatrix< Number > &jacobian)
Enforce nodal constraints in the Jacobian.
unsigned int _current_nl_its
boundary_id_type BoundaryID
Real referenceResidual() const
The reference residual used in relative convergence check.
void addSplit(const std::string &split_name, const std::string &name, InputParameters ¶meters)
Adds a split.
bool _automatic_scaling
Whether to automatically scale the variables.
MatFDColoring _fdcoloring
void computeJacobianTags(const std::set< TagID > &tags)
Computes multiple (tag associated) Jacobian matricese.
SolutionInvalidity & solutionInvalidity()
Get the SolutionInvalidity for this app.
std::shared_ptr< MoosePreconditioner > _preconditioner
Preconditioner.
virtual void timestepSetup(THREAD_ID tid=0) const
NonlinearSystemBase & currentNonlinearSystem()
SimpleRange< IndexType > as_range(const std::pair< IndexType, IndexType > &p)
void computingScalingResidual(bool computing_scaling_residual)
Setter for whether we're computing the scaling residual.
virtual void setupDM()=0
setup the data management data structure that manages the field split
SubProblem & subproblem()
std::vector< std::string > _vecs_to_zero_for_residual
vectors that will be zeroed before a residual computation
virtual TagID addMatrixTag(TagName tag_name)
Create a Tag.
std::shared_ptr< Split > getSplit(const std::string &name)
Retrieves a split by name.
TheWarehouse is a container for MooseObjects that allows querying/filtering over various customizeabl...
void setInitialSolution()
std::unique_ptr< NumericVector< Number > > solution
SubProblem & _subproblem
The subproblem for whom this class holds variable data, etc; this can either be the governing finite ...
void subdomainsCovered(std::set< SubdomainID > &subdomains_covered, std::set< std::string > &unique_variables, THREAD_ID tid=0) const
Populates a set of covered subdomains and the associated variable names.
void addImplicitGeometricCouplingEntries(GeometricSearchData &geom_search_data)
Adds entries to the Jacobian in the correct positions for couplings coming from dofs being coupled th...
virtual void addHDGKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
Adds a hybridized discontinuous Galerkin (HDG) kernel.
virtual void zero_rows(std::vector< numeric_index_type > &rows, T diag_value=0.0)
MooseObjectTagWarehouse< KernelBase > _kernels
MooseObjectWarehouse< T > & getMatrixTagObjectWarehouse(TagID tag_id, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has the given matrix tag...
bool shouldEvaluatePreSMOResidual() const
We offer the option to check convergence against the pre-SMO residual.
std::vector< VectorTag > getVectorTags(const std::set< TagID > &tag_ids) const
Base class for deriving nodal dampers.
virtual void disassociateVectorFromTag(NumericVector< Number > &vec, TagID tag)
Disassociate a given vector from a given tag.
virtual void cacheResidual(const THREAD_ID tid) override
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
virtual void computeScalingJacobian()=0
Compute a "Jacobian" for automatic scaling purposes.
bool errorOnJacobianNonzeroReallocation() const
Will return True if the user wants to get an error when a nonzero is reallocated in the Jacobian by P...
This is the ElementPairLocator class.
This is the ElementPairInfo class.
std::map< BoundaryID, std::shared_ptr< ElementPairLocator > > _element_pair_locators
Moose::CouplingType coupling() const
unsigned int number() const
Gets the number of this system.
void setupScalingData()
Setup group scaling containers.
virtual GeometricSearchData & geomSearchData()=0
const bool & usePreSMOResidual() const
Whether we are using pre-SMO residual in relative convergence checks.
MooseObjectTagWarehouse< HDGKernel > _hybridized_kernels
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.
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
Update this object's geometric search data as well as the displaced problem's if it exists...
void closeTaggedVectors(const std::set< TagID > &tags)
Close all vectors for given tags.
Base class for deriving any boundary condition that works at nodes.
void computeResidualInternal(const std::set< TagID > &tags)
Compute the residual for a given tag.
virtual void prepareAssembly(const THREAD_ID tid) override
bool computeScaling()
Method used to obtain scaling factors for variables.
std::vector< std::pair< MooseVariableFieldBase *, MooseVariableFieldBase * > > & couplingEntries(const THREAD_ID tid, const unsigned int nl_sys_num)
Interface for objects interacting with the PerfGraph.
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 bool hasVariable(const std::string &var_name) const
Query a system for a variable.
virtual void setCurrentSubdomainID(const Elem *elem, const THREAD_ID tid) override
virtual void clearDiracInfo() override
Gets called before Dirac Kernels are asked to add the points they are supposed to be evaluated in...
void destroyColoring()
Destroy the coloring object if it exists.
virtual void reinitNodesNeighbor(const std::vector< dof_id_type > &nodes, const THREAD_ID tid) override
bool identify_variable_groups() const
virtual void jacobianSetup(THREAD_ID tid=0) const
ConstraintWarehouse _constraints
Constraints storage object.
virtual void turnOffJacobian()
Turn off the Jacobian (must be called before equation system initialization)
void computeKokkosJacobian(const std::set< TagID > &tags)
Compute Jacobian with Kokkos objects.
TagID residualVectorTag() const override
const std::map< BoundaryID, std::vector< std::shared_ptr< T > > > & getActiveBoundaryObjects(THREAD_ID tid=0) const
void computingNonlinearResid(bool computing_nonlinear_residual) final
Set whether or not the problem is in the process of computing the nonlinear residual.
virtual void customSetup(const ExecFlagType &exec_type) override
ComputeType
The type of nonlinear computation being performed.
Base class for deriving element dampers.
Base interface for field split preconditioner.
bool _add_implicit_geometric_coupling_entries_to_jacobian
Whether or not to add implicit geometric couplings to the Jacobian for FDP.
const_iterator end() const
MooseObjectTagWarehouse< ResidualObject > _kokkos_integrated_bcs
void computeKokkosNodalBCsResidual(const std::set< TagID > &tags)
Compute Kokkos nodal BCs.
virtual void addNodalKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
Adds a NodalKernel.
virtual unsigned int numMatrixTags() const
The total number of tags.
Base class for creating new types of boundary conditions.
FEProblemBase & _fe_problem
the governing finite element/volume problem
virtual void reinitElemPhys(const Elem *elem, const std::vector< Point > &phys_points_in_elem, const THREAD_ID tid)=0
virtual MooseVariableScalar & getScalarVariable(THREAD_ID tid, const std::string &var_name) const
Gets a reference to a scalar variable with specified number.
ParallelType type() const
virtual NumericVector< Number > & RHS()=0
std::vector< VariableWarehouse > _vars
Variable warehouses (one for each thread)
const std::unordered_map< dof_id_type, std::vector< dof_id_type > > & nodeToElemMap()
If not already created, creates a map from every node to all elements to which they are connected...
Provides a way for users to bail out of the current solve.
unsigned int _n_residual_evaluations
Total number of residual evaluations that have been performed.
void addDiracKernel(const std::string &kernel_name, const std::string &name, InputParameters ¶meters)
Adds a Dirac kernel.
void computeJacobianInternal(const std::set< TagID > &tags)
Form multiple matrices for all the tags.
bool _has_diag_save_in
If there is any Kernel or IntegratedBC having diag_save_in.
Base class for creating new types of nodal kernels.
const FEType & variable_type(const unsigned int i) const
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual std::shared_ptr< const DisplacedProblem > getDisplacedProblem() const
std::unique_ptr< NumericVector< Number > > _residual_copy
Copy of the residual vector, or nullptr if a copy is not needed.
virtual void subdomainSetup()
bool hasSaveIn() const
Weather or not the nonlinear system has save-ins.
Generic class for solving transient nonlinear problems.
TagID timeVectorTag() const override
Ideally, we should not need this API.
Class for containing MooseEnum item information.
virtual std::vector< std::string > timeKernelVariableNames() override
Returns the names of the variables that have time derivative kernels in the system.
bool hasActiveObjects(THREAD_ID tid=0) const
NonlinearSystemBase(FEProblemBase &problem, libMesh::System &sys, const std::string &name)
void max(const T &r, T &o, Request &req) const
NumericVector< Number > * _u_dot
solution vector for u^dot
MooseObjectWarehouse< ElementDamper > _element_dampers
Element Dampers for each thread.
void addObject(std::shared_ptr< Constraint > object, THREAD_ID tid=0, bool recurse=true) override
Add Constraint object to the warehouse.
virtual void setSolutionUDot(const NumericVector< Number > &udot)
Set transient term used by residual and Jacobian evaluation.
virtual libMesh::SparseMatrix< Number > & getMatrix(TagID tag)
Get a raw SparseMatrix.
bool hasKokkosResidualObjects() const
virtual void augmentSparsity(libMesh::SparsityPattern::Graph &sparsity, std::vector< dof_id_type > &n_nz, std::vector< dof_id_type > &n_oz) override
Will modify the sparsity pattern to add logical geometric connections.
const std::vector< std::shared_ptr< MortarConstraintBase > > & getActiveMortarConstraints(const std::pair< BoundaryID, BoundaryID > &mortar_interface_key, bool displaced) const
MooseObjectWarehouse< T > & getMatrixTagsObjectWarehouse(const std::set< TagID > &tags, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has one of the given matrix tags...
void computeScalarKernelsJacobians(const std::set< TagID > &tags)
void setInitialResidual(Real r)
Record the initial residual (for later relative convergence check)
Query query()
query creates and returns an initialized a query object for querying objects from the warehouse...
virtual Assembly & assembly(const THREAD_ID tid, const unsigned int sys_num)=0
const_iterator begin() const
bool needInternalNeighborSideMaterial(SubdomainID subdomain_id, THREAD_ID tid) const
Indicates whether this system needs material properties on internal sides.
void computeKokkosResidual(const std::set< TagID > &tags)
Compute residual with Kokkos objects.
Base class for deriving dampers.
bool getFailNextNonlinearConvergenceCheck() const
Whether it will skip further residual evaluations and fail the next nonlinear convergence check(s) ...
Base class shared by AD and non-AD scalar kernels.
void addDamper(const std::string &damper_name, const std::string &name, InputParameters ¶meters)
Adds a damper.
IntRange< T > make_range(T beg, T end)
virtual MooseMesh & mesh() override
virtual void postAddResidualObject(ResidualObject &)
Called after any ResidualObject-derived objects are added to the system.
const std::vector< VariableName > & getVariableNames() const
virtual void preInit() override
This is called prior to the libMesh system has been init'd.
virtual void updateActive(THREAD_ID tid=0) override
Update the active status of Kernels.
virtual void timestepSetup() override
bool hasActiveElemElemConstraints(const InterfaceID interface_id, bool displaced) const
bool _off_diagonals_in_auto_scaling
Whether to include off diagonals when determining automatic scaling factors.
virtual unsigned int numVectorTags(const Moose::VectorTagType type=Moose::VECTOR_TAG_ANY) const
The total number of tags, which can be limited to the tag type.
void reinitNodeFace(const Node &secondary_node, const BoundaryID secondary_boundary, const PenetrationInfo &info, const bool displaced)
Reinitialize quantities such as variables, residuals, Jacobians, materials for node-face constraints...
Base class for deriving any boundary condition of a integrated type.
SolverParams & solverParams(unsigned int solver_sys_num=0)
Get the solver parameters.
NumericVector< Number > * _residual_ghosted
ghosted form of the residual
void setCachedJacobian(GlobalDataKey)
Sets previously-cached Jacobian values via SparseMatrix::set() calls.
TagID _Re_tag
Used for the residual vector from PETSc.
virtual void customSetup(const ExecFlagType &exec_type)
MooseObjectWarehouse< T > & getVectorTagObjectWarehouse(TagID tag_id, THREAD_ID tid)
Retrieve a moose object warehouse in which every moose object has the given vector tag...
const std::set< SubdomainID > & getSubdomainsForVar(unsigned int var_number) const
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true)
Adds an object to the storage structure.
bool ignoreZerosInJacobian() const
Will return true if zeros in the Jacobian are to be dropped from the sparsity pattern.
void computeNodalBCsJacobian(const std::set< TagID > &tags)
Compute the Jacobian for nodal boundary conditions.
const ExecFlagType EXEC_PRE_KERNELS
void mortarConstraints(Moose::ComputeType compute_type, const std::set< TagID > &vector_tags, const std::set< TagID > &matrix_tags)
Do mortar constraint residual/jacobian computations.
NumericVector< Number > * _increment_vec
increment vector
InterfaceKernelBase is the base class for all InterfaceKernel type classes.
QueryCache & condition(Args &&... args)
Adds a new condition to the query.
bool doingDG() const
Getter for _doing_dg.
void computeResidualTag(NumericVector< Number > &residual, TagID tag_id)
Computes residual for a given tag.
void addConstraint(const std::string &c_name, const std::string &name, InputParameters ¶meters)
Adds a Constraint.
virtual TagName vectorTagName(const TagID tag) const
Retrieve the name associated with a TagID.
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.
bool restoreOriginalNonzeroPattern() const
face_info_iterator ownedFaceInfoEnd()
void constraintJacobians(const SparseMatrix< Number > &jacobian_to_view, bool displaced)
Add jacobian contributions from Constraints.
virtual libMesh::System & system() override
Get the reference to the libMesh system.
MooseVariableFieldBase & getVariable(THREAD_ID tid, const std::string &var_name) const
Gets a reference to a variable of with specified name.
std::vector< BoundaryID > getBoundaryIDs(const Elem *const elem, const unsigned short int side) const
Returns a vector of boundary IDs for the requested element on the requested side. ...
bool preSolve()
Perform some steps to get ready for the solver.
void full_sparsity_pattern_needed()
bool _has_constraints
Whether or not this system has any Constraints.
dof_id_type first_dof(const processor_id_type proc) const
bool _computed_scaling
Flag used to indicate whether we have already computed the scaling Jacobian.
void remove_algebraic_ghosting_functor(GhostingFunctor &evaluable_functor)
MooseObjectTagWarehouse< InterfaceKernelBase > _interface_kernels
unsigned int n_vars() const
NumericVector< Number > & residualVector(TagID tag)
Return a residual vector that is associated with the residual tag.
NumericVector< Number > & solutionOld()
NumericVector< Number > & getResidualNonTimeVector()
Return a numeric vector that is associated with the nontime tag.
virtual bool hasScalarVariable(const std::string &var_name) const
const TagName PREVIOUS_NL_SOLUTION_TAG
processor_id_type processor_id() const
std::shared_ptr< Predictor > _predictor
If predictor is active, this is non-NULL.
void enforceNodalConstraintsResidual(NumericVector< Number > &residual)
Enforce nodal constraints.
void subdomainsCovered(std::set< SubdomainID > &subdomains_covered, std::set< std::string > &unique_variables, THREAD_ID tid=0) const
Update supplied subdomain and variable coverate containters.
MooseObjectWarehouse< GeneralDamper > _general_dampers
General Dampers.
const std::vector< std::shared_ptr< ElemElemConstraint > > & getActiveElemElemConstraints(InterfaceID interface_id, bool displaced) const
virtual void initialSetup()
Setup Functions.
bool defaultGhosting()
Whether or not the user has requested default ghosting ot be on.
void addCachedJacobian(GlobalDataKey)
Adds the values that have been cached by calling cacheJacobian() and or cacheJacobianNeighbor() to th...
virtual void cacheJacobian(const THREAD_ID tid) override
auto min(const L &left, const R &right)
void jacobianSetup() override
void setKokkosInitialSolution()
virtual NumericVector< Number > & getVector(const std::string &name)
Get a raw NumericVector by name.
MooseObjectTagWarehouse< IntegratedBCBase > _integrated_bcs
const DofMap & get_dof_map() const
virtual void reinitNodeFace(const Node *node, BoundaryID bnd_id, const THREAD_ID tid) override
virtual void residualSetup()
virtual void reinitOffDiagScalars(const THREAD_ID tid) override
processor_id_type processor_id() const
virtual void addObject(std::shared_ptr< T > object, THREAD_ID tid=0, bool recurse=true) override
Adds an object to the storage structure.
virtual void setNeighborSubdomainID(const Elem *elem, unsigned int side, const THREAD_ID tid) override
virtual void addResidualScalar(const THREAD_ID tid=0)
virtual void subdomainSetup(THREAD_ID tid=0) const
virtual void jacobianSetup() override
virtual void addCachedResidual(const THREAD_ID tid) override
std::vector< std::vector< std::string > > _scaling_group_variables
A container of variable groupings that can be used in scaling calculations.
void addInterfaceKernel(std::string interface_kernel_name, const std::string &name, InputParameters ¶meters)
Adds an interface kernel.
FieldSplitPreconditionerBase * _fsp
The field split preconditioner if this sytem is using one.
auto index_range(const T &sizable)
virtual NumericVector< Number > & residualCopy() override
void reinitMortarFunctors()
Update the mortar functors if the mesh has changed.
virtual NumericVector< Number > & residualGhosted() override
DiracKernelBase is the base class for all DiracKernel type classes.
virtual void updateActive(THREAD_ID tid=0)
Updates the active objects storage.
MooseObjectTagWarehouse< ResidualObject > _kokkos_nodal_bcs
void assembleScalingVector()
Assemble the numeric vector of scaling factors such that it can be used during assembly of the system...
BoundaryID _primary_boundary
NumericVector< Number > * _u_dotdot_old
old solution vector for u^dotdot
MooseObjectTagWarehouse< ScalarKernelBase > _scalar_kernels
virtual void residualEnd(THREAD_ID tid=0) const
const std::unordered_map< std::pair< BoundaryID, BoundaryID >, MortarInterfaceConfig > & getMortarInterfaces(bool on_displaced) const
void setConstraintSecondaryValues(NumericVector< Number > &solution, bool displaced)
Sets the value of constrained variables in the solution vector.
virtual void addJacobianScalar(const THREAD_ID tid=0)
NearestNodeLocator & _nearest_node
const std::set< SubdomainID > & meshSubdomains() const
Returns a read-only reference to the set of subdomains currently present in the Mesh.
virtual void addCachedJacobian(const THREAD_ID tid) override
virtual void timestepSetup()
virtual ~NonlinearSystemBase()
virtual void preInit() override
This is called prior to the libMesh system has been init'd.
virtual void residualSetup() override
void setPreconditioner(std::shared_ptr< MoosePreconditioner > pc)
Sets a preconditioner.
virtual void localize(std::vector< T > &v_local) const=0
MooseObjectWarehouse< ADDirichletBCBase > _ad_preset_nodal_bcs
virtual libMesh::System & system() override
Get the reference to the libMesh system.
Key structure for APIs manipulating global vectors/matrices.