createNonConformalCouples: Put non-conformal couple settings in a sub dictionary

Settings for the individual non-conformal couples can now be put in a
"nonConformalCouples" sub-dictionary of the
system/createNonConformalCouplesDict. For example:

    fields  no;

    nonConformalCouples // <-- new sub-dictionary
    {
        nonConformalCouple_none
        {
            patches         (nonCouple1 nonCouple2);
            transform       none;
        }

        nonConformalCouple_30deg
        {
            patches         (nonCoupleBehind nonCoupleAhead);
            transform       rotational;
            rotationAxis    (-1 0 0);
            rotationCentre  (0 0 0);
            rotationAngle   30;
        }
    }

This permits settings to be #include-d from files that themselves
contain sub-dictionaries without the utility treating those
sub-dictionaries as if they specify a non-conformal coupling. It also
makes the syntax more comparable to that of createBafflesDict.

The new "nonConformalCouples" sub-dictionary is optional, so this change
is backwards compatible. The new syntax is recommended, however, and all
examples have been changed accordingly.

applications/utilities/mesh/manipulation/createNonConformalCouples/createNonConformalCouples.C

@@ -357,7 +357,10 @@ int main(int argc, char *argv[])
 
         fields = dict.lookupOrDefault<bool>("fields", false);
 
-        forAllConstIter(dictionary, dict, iter)
+        const dictionary& couplesDict =
+            dict.optionalSubDict("nonConformalCouples");
+
+        forAllConstIter(dictionary, couplesDict, iter)
         {
             if (!iter().isDict()) continue;
 

etc/caseDicts/annotated/createNonConformalCouplesDict

@@ -14,8 +14,13 @@ FoamFile
 }
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
-// Each couple has its own entry in this file. Entries take the following form:
+// Whether or not to add boundary conditions for the added patch to the fields
+fields  no;
 
+// The list of non-conformal couples to be created. Each entry in this section
+// creates a single non-conformal coupling.
+nonConformalCouples
+{
     /*
     // Unique name used to generate the name of the coupled patches
     <name>
@@ -31,17 +36,15 @@ FoamFile
     }
     */
 
-
+    // Example: Create a non-conformal couple with no transformation
-// Examples:
-
-// Create a non-conformal couple with no transformation
     nonConformalCouple_none
     {
         patches         (nonCouple1 nonCouple2);
         transform       none;
     }
 
-// Create a non-conformal couple with a 30 degree rotational transformation
+    // Example: Create a non-conformal couple with a 30 degree rotational
+    // transformation
     nonConformalCouple_30deg
     {
         patches         (nonCoupleBehind nonCoupleAhead);
@@ -51,19 +54,19 @@ nonConformalCouple_30deg
         rotationAngle   30;
     }
 
-// Create a non-conformal couple with a 2 metre translational transformation
+    // Example: Create a non-conformal couple with a 2 metre translational
+    // transformation
     nonConformalCouple_2m
     {
         patches         (nonCoupleBack nonCoupleFront);
         transform       translational;
         separation      (0 2 0);
     }
-
+}
 
 // Note that in rare cases it may be appropriate to create multiple couplings
 // between the same two patches. That can be achieved with multiple entries
 // with the same patches specified. See the
 // incompressible/pimpleFoam/RAS/impeller tutorial for an example of this.
 
-
 // ************************************************************************* //

etc/templates/closedVolumeRotating/system/createNonConformalCouplesDict

@@ -16,10 +16,13 @@ FoamFile
 
 fields true;
 
+nonConformalCouples
+{
     NCC
     {
         patches         (nonCouple1 nonCouple2);
         transform       none;
     }
+}
 
 // ************************************************************************* //

etc/templates/inflowOutflowRotating/system/createNonConformalCouplesDict

@@ -16,10 +16,13 @@ FoamFile
 
 fields true;
 
+nonConformalCouples
+{
     NCC
     {
         patches         (nonCouple1 nonCouple2);
         transform       none;
     }
+}
 
 // ************************************************************************* //

tutorials/modules/incompressibleFluid/impeller/system/createNonConformalCouplesDict

@@ -14,6 +14,8 @@ FoamFile
 }
 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
+nonConformalCouples
+{
     nonConformalCoupleIn0
     {
         patches         (nonCoupleIn1 nonCoupleIn2);
@@ -65,5 +67,6 @@ nonConformalCoupleOut240 { $nonConformalCoupleOut30; rotationAngle -240; }
     nonConformalCoupleOut270 { $nonConformalCoupleOut30; rotationAngle -270; }
     nonConformalCoupleOut300 { $nonConformalCoupleOut30; rotationAngle -300; }
     nonConformalCoupleOut330 { $nonConformalCoupleOut30; rotationAngle -330; }
+}
 
 // ************************************************************************* //