Merge pull request #27392 from farscape-project/coupleable

Add methods for array vars to the Coupleable API docs

framework/doc/content/source/interfaces/Coupleable.md

@@ -25,6 +25,17 @@ The following tables summarize the methods it provides.
 
 ---
 
+| Methods for array field variables | Description |
+| :--- | :--- |
+`coupledArrayValue`‡ | Value of a coupled array variable at q-points
+`coupledArrayGradient`‡ | Gradient of a coupled array variable at q-points
+`coupledArrayDot`† | Time derivative of a coupled array variable at q-points
+`coupledArrayDotDot`† | Second time derivative of a coupled array variable at q-points
+`coupledArrayDotDu` | Derivative with regards to the variable of the time derivative of a coupled array variable at q-points
+`coupledArrayGradientDot` | Time derivative of the gradient of a coupled array variable at q-points
+
+---
+
 | Methods for vector field variables | Description |
 | :--- | :--- |
 `coupledVectorValue`ठ| Value of a coupled vector variable at q-points

framework/include/interfaces/Coupleable.h

@@ -480,8 +480,8 @@ class Coupleable
 
   /**
    * Returns value of a coupled array variable
-   * @param var_name Name of coupled vector variable
-   * @param comp Component number for vector of coupled vector variables
+   * @param var_name Name of coupled array variable
+   * @param comp Component number for vector of coupled array variables
    * @return Reference to a ArrayVariableValue for the coupled vector variable
    * @see ArrayKernel::_u
    */
@@ -589,9 +589,9 @@ class Coupleable
                                                               unsigned int comp = 0) const;
 
   /**
-   * Returns an old value from previous time step  of a coupled array variable
-   * @param var_name Name of coupled variable
-   * @param comp Component number for vector of coupled variables
+   * Returns an old value from previous time step of a coupled array variable
+   * @param var_name Name of coupled array variable
+   * @param comp Component number for vector of coupled array variables
    * @return Reference to a ArrayVariableValue containing the old value of the coupled variable
    * @see ArrayKernel::_u_old
    */
@@ -600,8 +600,8 @@ class Coupleable
 
   /**
    * Returns an old value from two time steps previous of a coupled array variable
-   * @param var_name Name of coupled variable
-   * @param comp Component number for vector of coupled variables
+   * @param var_name Name of coupled array variable
+   * @param comp Component number for vector of coupled array variables
    * @return Reference to a ArrayVariableValue containing the older value of the coupled variable
    * @see ArrayKernel::_u_older
    */
@@ -1137,8 +1137,8 @@ class Coupleable
 
   /**
    * Time derivative of a coupled array variable with respect to the coefficients
-   * @param var_name Name of coupled vector variable
-   * @param comp Component number for vector of coupled vector variables
+   * @param var_name Name of coupled array variable
+   * @param comp Component number for vector of coupled array variables
    * @return Reference to a ArrayVariableValue containing the time derivative of the coupled
    * variable
    */