ENH: Updated boundary condition documentation

src/finiteVolume/fields/fvPatchFields/derived/fixedJump/fixedJumpFvPatchField.H

@@ -28,14 +28,37 @@ Group
     grpCoupledBoundaryConditions
 
 Description
-    Base class for "jump" of a field<type>
+    This boundary condition provides a jump condition, using the \c cyclic
+    condition as a base.
+
+    The jump is specified as a fixed value field, applied as an offset to the
+    'owner' patch.
+
+    \heading Patch usage
+
+    \table
+        Property     | Description             | Required    | Default value
+        patchType    | underlying patch type should be \c cyclic| yes |
+        jump         | current jump value      | yes         |
+    \endtable
+
+    Example of the boundary condition specification:
+    \verbatim
+    myPatch
+    {
+        type            fixedJump;
+        patchType       cyclic;
+        jump            uniform 10;
+    }
+    \endverbatim
+
+    The above example shows the use of a fixed jump of '10'.
 
 Note
-    not used directly
+     The underlying \c patchType should be set to \c cyclic
 
 SeeAlso
-    Foam::fanFvPatchScalarField
-    Foam::fanPressureFvPatchScalarField
+    Foam::jumpCyclicFvPatchField
 
 SourceFiles
     fixedJumpFvPatchField.C

src/finiteVolume/fields/fvPatchFields/derived/fixedJumpAMI/fixedJumpAMIFvPatchField.H

@@ -27,6 +27,36 @@ Class
 Group
     grpCoupledBoundaryConditions
 
+Description
+    This boundary condition provides a jump condition, across non-conformal
+    cyclic path-pairs, employing an arbitraryMeshInterface (AMI).
+
+    The jump is specified as a fixed value field, applied as an offset to the
+    'owner' patch.
+
+    \heading Patch usage
+
+    \table
+        Property     | Description             | Required    | Default value
+        patchType    | underlying patch type should be \c cyclic| yes |
+        jump         | current jump value      | yes         |
+    \endtable
+
+    Example of the boundary condition specification:
+    \verbatim
+    myPatch
+    {
+        type            fixedJumpAMI;
+        patchType       cyclic;
+        jump            uniform 10;
+    }
+    \endverbatim
+
+    The above example shows the use of a fixed jump of '10'.
+
+Note
+     The underlying \c patchType should be set to \c cyclicAMI
+
 SeeAlso
     Foam::jumpCyclicAMIFvPatchField
 

src/finiteVolume/fields/fvPatchFields/derived/uniformJump/uniformJumpFvPatchField.H

@@ -27,11 +27,39 @@ Class
 Group
     grpCoupledBoundaryConditions
 
-Description
-    Uniform jump
+    This boundary condition provides a jump condition, using the \c cyclic
+    condition as a base.  The jump is specified as a time-varying uniform
+    value across the patch.
+
+    \heading Patch usage
+
+    \table
+        Property     | Description             | Required    | Default value
+        patchType    | underlying patch type should be \c cyclic| yes |
+        jumpTable    | jump value              | yes         |
+    \endtable
+
+    Example of the boundary condition specification:
+    \verbatim
+    myPatch
+    {
+        type            fixedJump;
+        patchType       cyclic;
+        jumpTable       constant 10;
+    }
+    \endverbatim
+
+    The above example shows the use of a fixed jump of '10'.
+
+Note
+    The uniformValue entry is a DataEntry type, able to describe time
+    varying functions.  The example above gives the usage for supplying a
+    constant value.
+
+    The underlying \c patchType should be set to \c cyclic
 
 SeeAlso
-    Foam::jumpCyclicFvPatchField
+    Foam::fixedJumpFvPatchField
 
 SourceFiles
     uniformJumpFvPatchField.C

src/finiteVolume/fields/fvPatchFields/derived/uniformJumpAMI/uniformJumpAMIFvPatchField.H

@@ -28,7 +28,36 @@ Group
     grpCoupledBoundaryConditions
 
 Description
-    Uniform jump
+    This boundary condition provides a jump condition, using the \c cyclicAMI
+    condition as a base.  The jump is specified as a time-varying uniform
+    value across the patch.
+
+    \heading Patch usage
+
+    \table
+        Property     | Description             | Required    | Default value
+        patchType    | underlying patch type should be \c cyclic| yes |
+        jumpTable    | jump value              | yes         |
+    \endtable
+
+    Example of the boundary condition specification:
+    \verbatim
+    myPatch
+    {
+        type            uniformJumpAMI;
+        patchType       cyclicAMI;
+        jumpTable       constant 10;
+    }
+    \endverbatim
+
+    The above example shows the use of a fixed jump of '10'.
+
+Note
+    The uniformValue entry is a DataEntry type, able to describe time
+    varying functions.  The example above gives the usage for supplying a
+    constant value.
+
+    The underlying \c patchType should be set to \c cyclic
 
 SeeAlso
     Foam::jumpCyclicAMIFvPatchField

src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJump/energyJumpFvPatchScalarField.H

@@ -29,23 +29,8 @@ Group
 
 Description
     This boundary condition provides an energy jump condition across a pair
-    of coupled patches.
-
-    \heading Patch usage
-
-    \table
-        Property     | Description             | Required    | Default value
-        jump         | energy jump values      | yes         |
-    \endtable
-
-    Example of the boundary condition specification:
-    \verbatim
-    myPatch
-    {
-        type            energyJump;
-        jump            uniform 100;
-    }
-    \endverbatim
+    of coupled patches.  It is not applied directly, but is employed on-the-fly
+    when converting temperature boundary conditions into energy.
 
 SeeAlso
     Foam::fixedJumpFvPatchField

src/thermophysicalModels/basic/derivedFvPatchFields/energyJump/energyJumpAMI/energyJumpAMIFvPatchScalarField.H

@@ -29,26 +29,12 @@ Group
 
 Description
     This boundary condition provides an energy jump condition across a pair
-    of coupled patches.
-
-    \heading Patch usage
-
-    \table
-        Property     | Description             | Required    | Default value
-        jump         | energy jump values      | yes         |
-    \endtable
-
-    Example of the boundary condition specification:
-    \verbatim
-    myPatch
-    {
-        type            energyJumpAMI;
-        jump            uniform 100;
-    }
-    \endverbatim
+    of coupled patches with an arbitrary mesh interface (AMI).  It is not
+    applied directly, but is employed on-the-fly when converting temperature
+    boundary conditions into energy.
 
 SeeAlso
-    Foam::fixedJumpFvPatchField
+    Foam::fixedJumpAMIFvPatchField
 
 SourceFiles
     energyJumpAMIFvPatchScalarField.C

src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJump/uniformTemperatureJumpFvPatchScalarField.H

@@ -29,7 +29,7 @@ Group
 
 Description
     This boundary condition provides a temperature jump condition across a
-    coupled pair of cyclic patches when solving for energy.
+    coupled pair of cyclic patches, when solving for energy.
 
     The jump is specified as a \c DataEntry type, to enable the use of, e.g.
     contant, polynomial, table values.
@@ -39,7 +39,6 @@ Description
     \table
         Property     | Description             | Required    | Default value
         patchType    | underlying patch type should be \c cyclic| yes |
-        jump         | current jump value      | yes         |
         jumpTable    | jump data, e.g. \c csvFile | yes      |
     \endtable
 
@@ -54,7 +53,7 @@ Description
     }
     \endverbatim
 
-    The above example shows the use of a constant jump condition.
+    The above example shows the use of a constant jump condition of 300 K.
 
 Note
      The underlying \c patchType should be set to \c cyclic

src/thermophysicalModels/basic/derivedFvPatchFields/temperatureJump/uniformTemperatureJumpAMI/uniformTemperatureJumpAMIFvPatchScalarField.H

@@ -29,7 +29,8 @@ Group
 
 Description
     This boundary condition provides a temperature jump condition across a
-    coupled pair of cyclic patches when solving for energy.
+    coupled pair of non-conformal cyclic patches using an arbitrary mesh
+    interface (AMI), when solving for energy.
 
     The jump is specified as a \c DataEntry type, to enable the use of, e.g.
     contant, polynomial, table values.
@@ -39,7 +40,6 @@ Description
     \table
         Property     | Description             | Required    | Default value
         patchType    | underlying patch type should be \c cyclic| yes |
-        jump         | current jump value      | yes         |
         jumpTable    | jump data, e.g. \c csvFile | yes      |
     \endtable
 
@@ -54,14 +54,14 @@ Description
     }
     \endverbatim
 
-    The above example shows the use of a constant jump condition.
+    The above example shows the use of a constant jump condition of 300 K.
 
 Note
-     The underlying \c patchType should be set to \c cyclic
+     The underlying \c patchType should be set to \c cyclicAMI
 
 SeeAlso
-    Foam::uniformJumpFvPatchField
-    Foam::energyJumpFvPatchScalarField
+    Foam::uniformJumpAMIFvPatchField
+    Foam::energyJumpAMIFvPatchScalarField
 
 SourceFiles
     uniformTemperatureJumpAMIFvPatchScalarField.C