Fix and test user object support (idaholab#22563)

framework/src/loops/ComputeNodalUserObjectsThread.C

@@ -91,6 +91,15 @@ ComputeNodalUserObjectsThread::onNode(ConstNodeRange::const_iterator & node_it)
       if (!uo->isUniqueNodeExecute() || computed.count(uo) == 0)
       {
         uo->execute();
+
+        // update the aux solution vector if writable coupled variables are used
+        if (uo->hasWritableCoupledVariables())
+        {
+          Threads::spin_mutex::scoped_lock lock(writable_variable_mutex);
+          for (auto * var : uo->getWritableCoupledVariables())
+            var->insert(_aux_sys.solution());
+        }
+
         computed.insert(uo);
       }
   }

test/include/userobjects/MultiUpdateElementalUO.h

@@ -0,0 +1,31 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#pragma once
+
+#include "ElementUserObject.h"
+
+/**
+ * Test object for the writableVariable API for nodal values
+ */
+class MultiUpdateElementalUO : public ElementUserObject
+{
+public:
+  static InputParameters validParams();
+
+  MultiUpdateElementalUO(const InputParameters & parameters);
+
+  virtual void initialize() override {}
+  virtual void execute() override;
+  virtual void finalize() override {}
+  virtual void threadJoin(const UserObject &) override {}
+
+protected:
+  MooseVariable & _v;
+};

test/include/userobjects/MultiUpdateNodalUO.h

@@ -0,0 +1,31 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#pragma once
+
+#include "NodalUserObject.h"
+
+/**
+ * Test object for the writableVariable API for nodal values
+ */
+class MultiUpdateNodalUO : public NodalUserObject
+{
+public:
+  static InputParameters validParams();
+
+  MultiUpdateNodalUO(const InputParameters & parameters);
+
+  virtual void initialize() override {}
+  virtual void execute() override;
+  virtual void finalize() override {}
+  virtual void threadJoin(const UserObject &) override {}
+
+protected:
+  MooseVariable & _v;
+};

test/src/userobjects/MultiUpdateElementalUO.C

@@ -0,0 +1,33 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#include "MultiUpdateElementalUO.h"
+
+registerMooseObject("MooseTestApp", MultiUpdateElementalUO);
+
+InputParameters
+MultiUpdateElementalUO::validParams()
+{
+  InputParameters params = ElementUserObject::validParams();
+  params.addClassDescription("Test object for the writableVariable API for elemental values");
+  params.addRequiredCoupledVar("v", "Coupled variable that will be written to by the test object.");
+  return params;
+}
+
+MultiUpdateElementalUO::MultiUpdateElementalUO(const InputParameters & parameters)
+  : ElementUserObject(parameters), _v(writableVariable("v"))
+{
+}
+
+void
+MultiUpdateElementalUO::execute()
+{
+  // it really is a DOF value
+  _v.setNodalValue(1.23);
+}

test/src/userobjects/MultiUpdateNodalUO.C

@@ -0,0 +1,32 @@
+//* This file is part of the MOOSE framework
+//* https://www.mooseframework.org
+//*
+//* All rights reserved, see COPYRIGHT for full restrictions
+//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
+//*
+//* Licensed under LGPL 2.1, please see LICENSE for details
+//* https://www.gnu.org/licenses/lgpl-2.1.html
+
+#include "MultiUpdateNodalUO.h"
+
+registerMooseObject("MooseTestApp", MultiUpdateNodalUO);
+
+InputParameters
+MultiUpdateNodalUO::validParams()
+{
+  InputParameters params = NodalUserObject::validParams();
+  params.addClassDescription("Test object for the writableVariable API for nodal values");
+  params.addRequiredCoupledVar("v", "Coupled variable that will be written to by the test object.");
+  return params;
+}
+
+MultiUpdateNodalUO::MultiUpdateNodalUO(const InputParameters & parameters)
+  : NodalUserObject(parameters), _v(writableVariable("v"))
+{
+}
+
+void
+MultiUpdateNodalUO::execute()
+{
+  _v.setNodalValue(1.23);
+}

test/tests/auxkernels/nodal_aux_var/tests

@@ -57,6 +57,14 @@
                   "auxiliary variables within a single AuxKernel object."
   []
 
+  [multi_update_elem_family_error]
+    type = 'RunException'
+    input = 'multi_update_elem_var_test.i'
+    cli_args = 'AuxVariables/ten/order=FIRST AuxVariables/ten/family=LAGRANGE'
+    expect_err = "The AuxKernel 'all' and the variable 'ten' must both either be nodal or elemental."
+    requirement = "The MOOSE auxiliary system shall check compatibility between primary and writable coupled variables."
+  []
+
   [ts_test]
     type = 'Exodiff'
     input = 'nodal_aux_ts_test.i'

test/tests/userobjects/writable_variable/elemental.i

@@ -0,0 +1,35 @@
+[Mesh]
+  [gen]
+    type = GeneratedMeshGenerator
+    dim = 2
+    nx = 1
+    ny = 1
+  []
+[]
+
+[AuxVariables]
+  [v]
+    family = MONOMIAL
+    order = CONSTANT
+  []
+[]
+
+[UserObjects]
+  [elemental]
+    type = MultiUpdateElementalUO
+    v = v
+  []
+[]
+
+[Problem]
+  kernel_coverage_check = false
+  solve = false
+[]
+
+[Executioner]
+  type = Steady
+[]
+
+[Outputs]
+  exodus = true
+[]

test/tests/userobjects/writable_variable/nodal.i

@@ -0,0 +1,35 @@
+[Mesh]
+  [gen]
+    type = GeneratedMeshGenerator
+    dim = 2
+    nx = 1
+    ny = 1
+  []
+[]
+
+[AuxVariables]
+  [v]
+    family = LAGRANGE
+    order = FIRST
+  []
+[]
+
+[UserObjects]
+  [elemental]
+    type = MultiUpdateNodalUO
+    v = v
+  []
+[]
+
+[Problem]
+  kernel_coverage_check = false
+  solve = false
+[]
+
+[Executioner]
+  type = Steady
+[]
+
+[Outputs]
+  exodus = true
+[]

test/tests/userobjects/writable_variable/tests

@@ -0,0 +1,12 @@
+[Tests]
+  [nodal]
+    type = Exodiff
+    input = nodal.i
+    exodiff = nodal_out.e
+  []
+  [elemental]
+    type = Exodiff
+    input = elemental.i
+    exodiff = elemental_out.e
+  []
+[]